Class: Google::Cloud::Compute::V1::MachineImage

Inherits:

Object

Object
Google::Cloud::Compute::V1::MachineImage

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/compute/v1/compute.rb

Overview

Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

#creation_timestamp ⇒ ::String
[Output Only] The creation timestamp for this machine image in RFC3339 text format.
#description ⇒ ::String
An optional description of this resource.
#guest_flush ⇒ ::Boolean
[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.
#id ⇒ ::Integer
[Output Only] A unique identifier for this machine image.
#instance_properties ⇒ ::Google::Cloud::Compute::V1::InstanceProperties
[Output Only] Properties of source instance.
#kind ⇒ ::String
[Output Only] The resource type, which is always compute#machineImage for machine image.
#machine_image_encryption_key ⇒ ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Encrypts the machine image using a customer-supplied encryption key.
#name ⇒ ::String
Name of the resource; provided by the client when the resource is created.
#satisfies_pzi ⇒ ::Boolean
Output only.
#satisfies_pzs ⇒ ::Boolean
[Output Only] Reserved for future use.
#saved_disks ⇒ ::Array<::Google::Cloud::Compute::V1::SavedDisk>
An array of Machine Image specific properties for disks attached to the source instance.
#self_link ⇒ ::String
[Output Only] The URL for this machine image.
#source_disk_encryption_keys ⇒ ::Array<::Google::Cloud::Compute::V1::SourceDiskEncryptionKey>
[Input Only] The customer-supplied encryption key of the disks attached to the source instance.
#source_instance ⇒ ::String
The source instance used to create the machine image.
#source_instance_properties ⇒ ::Google::Cloud::Compute::V1::SourceInstanceProperties
[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties.
#status ⇒ ::String
[Output Only] The status of the machine image.
#storage_locations ⇒ ::Array<::String>
The regional or multi-regional Cloud Storage bucket location where the machine image is stored.
#total_storage_bytes ⇒ ::Integer
[Output Only] Total size of the storage used by the machine image.

Instance Attribute Details

#creation_timestamp ⇒ `::String`

Returns [Output Only] The creation timestamp for this machine image in RFC3339 text format.

Returns:

(::String) —
[Output Only] The creation timestamp for this machine image in RFC3339 text format.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#description ⇒ `::String`

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

(::String) —
An optional description of this resource. Provide this property when you create the resource.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#guest_flush ⇒ `::Boolean`

Returns [Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.

Returns:

(::Boolean) —
[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#id ⇒ `::Integer`

Returns [Output Only] A unique identifier for this machine image. The server defines this identifier.

Returns:

(::Integer) —
[Output Only] A unique identifier for this machine image. The server defines this identifier.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#instance_properties ⇒ `::Google::Cloud::Compute::V1::InstanceProperties`

Returns [Output Only] Properties of source instance.

Returns:

(::Google::Cloud::Compute::V1::InstanceProperties) —
[Output Only] Properties of source instance

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#kind ⇒ `::String`

Returns [Output Only] The resource type, which is always compute#machineImage for machine image.

Returns:

(::String) —
[Output Only] The resource type, which is always compute#machineImage for machine image.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#machine_image_encryption_key ⇒ `::Google::Cloud::Compute::V1::CustomerEncryptionKey`

Returns Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.

Returns:

(::Google::Cloud::Compute::V1::CustomerEncryptionKey) —
Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#name ⇒ `::String`

Returns Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns:

(::String) —
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#satisfies_pzi ⇒ `::Boolean`

Returns Output only. Reserved for future use.

Returns:

(::Boolean) —
Output only. Reserved for future use.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#satisfies_pzs ⇒ `::Boolean`

Returns [Output Only] Reserved for future use.

Returns:

(::Boolean) —
[Output Only] Reserved for future use.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#saved_disks ⇒ `::Array<::Google::Cloud::Compute::V1::SavedDisk>`

Returns An array of Machine Image specific properties for disks attached to the source instance.

Returns:

(::Array<::Google::Cloud::Compute::V1::SavedDisk>) —
An array of Machine Image specific properties for disks attached to the source instance

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#self_link ⇒ `::String`

Returns [Output Only] The URL for this machine image. The server defines this URL.

Returns:

(::String) —
[Output Only] The URL for this machine image. The server defines this URL.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#source_disk_encryption_keys ⇒ `::Array<::Google::Cloud::Compute::V1::SourceDiskEncryptionKey>`

Returns [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

Returns:

(::Array<::Google::Cloud::Compute::V1::SourceDiskEncryptionKey>) —
[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#source_instance ⇒ `::String`

Returns The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance.

Returns:

(::String) —
The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#source_instance_properties ⇒ `::Google::Cloud::Compute::V1::SourceInstanceProperties`

Returns [Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

Returns:

(::Google::Cloud::Compute::V1::SourceInstanceProperties) —
[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#status ⇒ `::String`

Returns [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. Check the Status enum for the list of possible values.

Returns:

(::String) —
[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. Check the Status enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#storage_locations ⇒ `::Array<::String>`

Returns The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

Returns:

(::Array<::String>) —
The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

#total_storage_bytes ⇒ `::Integer`

Returns [Output Only] Total size of the storage used by the machine image.

Returns:

(::Integer) —
[Output Only] Total size of the storage used by the machine image.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20082

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

  # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963

    UPLOADING = 267_603_489
  end
end

Class: Google::Cloud::Compute::V1::MachineImage

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timestamp ⇒ ::String

#description ⇒ ::String

#guest_flush ⇒ ::Boolean

#id ⇒ ::Integer

#instance_properties ⇒ ::Google::Cloud::Compute::V1::InstanceProperties

#kind ⇒ ::String

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

#name ⇒ ::String

#satisfies_pzi ⇒ ::Boolean

#satisfies_pzs ⇒ ::Boolean

#saved_disks ⇒ ::Array<::Google::Cloud::Compute::V1::SavedDisk>

#self_link ⇒ ::String

#source_disk_encryption_keys ⇒ ::Array<::Google::Cloud::Compute::V1::SourceDiskEncryptionKey>

#source_instance ⇒ ::String

#source_instance_properties ⇒ ::Google::Cloud::Compute::V1::SourceInstanceProperties

#status ⇒ ::String

#storage_locations ⇒ ::Array<::String>

#total_storage_bytes ⇒ ::Integer

#creation_timestamp ⇒ `::String`

#description ⇒ `::String`

#guest_flush ⇒ `::Boolean`

#id ⇒ `::Integer`

#instance_properties ⇒ `::Google::Cloud::Compute::V1::InstanceProperties`

#kind ⇒ `::String`

#machine_image_encryption_key ⇒ `::Google::Cloud::Compute::V1::CustomerEncryptionKey`

#name ⇒ `::String`

#satisfies_pzi ⇒ `::Boolean`

#satisfies_pzs ⇒ `::Boolean`

#saved_disks ⇒ `::Array<::Google::Cloud::Compute::V1::SavedDisk>`

#self_link ⇒ `::String`

#source_disk_encryption_keys ⇒ `::Array<::Google::Cloud::Compute::V1::SourceDiskEncryptionKey>`

#source_instance ⇒ `::String`

#source_instance_properties ⇒ `::Google::Cloud::Compute::V1::SourceInstanceProperties`

#status ⇒ `::String`

#storage_locations ⇒ `::Array<::String>`

#total_storage_bytes ⇒ `::Integer`