Class: Google::Cloud::Compute::V1::AttachedDiskInitializeParams

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/compute/v1/compute.rb

Overview

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Defined Under Namespace

Modules: OnUpdateAction Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns An optional description. Provide this property when creating the disk.

Returns:

  • (::String) —

    An optional description. Provide this property when creating the disk.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#disk_name ⇒ ::String

Returns Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

Returns:

  • (::String) —

    Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#disk_size_gb ⇒ ::Integer

Returns Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

Returns:

  • (::Integer) —

    Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#disk_type ⇒ ::String

Returns Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Returns:

  • (::String) —

    Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#on_update_action ⇒ ::String

Returns Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

Returns:

  • (::String) —

    Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#provisioned_iops ⇒ ::Integer

Returns Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Returns:

  • (::Integer) —

    Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#resource_policies ⇒ ::Array<::String>

Returns Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

Returns:

  • (::Array<::String>) —

    Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#source_image ⇒ ::String

Returns The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

Returns:

  • (::String) —

    The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#source_image_encryption_key ⇒ ::Google::Cloud::Compute::V1::CustomerEncryptionKey

Returns The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Returns:

  • (::Google::Cloud::Compute::V1::CustomerEncryptionKey) —

    The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#source_snapshot ⇒ ::String

Returns The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Returns:

  • (::String) —

    The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end

#source_snapshot_encryption_key ⇒ ::Google::Cloud::Compute::V1::CustomerEncryptionKey

Returns The customer-supplied encryption key of the source snapshot.

Returns:



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 1997

class AttachedDiskInitializeParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
  module OnUpdateAction
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_UPDATE_ACTION = 0

    # Always recreate the disk.
    RECREATE_DISK = 494767853

    # Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
    RECREATE_DISK_IF_SOURCE_CHANGED = 398099712

    # Use the existing disk, this is the default behaviour.
    USE_EXISTING_DISK = 232682233
  end
end