GoogleApi.Compute.V1.Model.Image (google_api_compute v0.37.0) View Source

Represents an Image resource.

You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==)

Attributes

  • archiveSizeBytes (type: String.t, default: nil) - Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

  • creationTimestamp (type: String.t, default: nil) - [Output Only] Creation timestamp in RFC3339 text format.

  • deprecated (type: GoogleApi.Compute.V1.Model.DeprecationStatus.t, default: nil) - The deprecation status associated with this image.

  • description (type: String.t, default: nil) - An optional description of this resource. Provide this property when you create the resource.

  • diskSizeGb (type: String.t, default: nil) - Size of the image when restored onto a persistent disk (in GB).

  • family (type: String.t, default: nil) - The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

  • guestOsFeatures (type: list(GoogleApi.Compute.V1.Model.GuestOsFeature.t), default: nil) - A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

  • id (type: String.t, default: nil) - [Output Only] The unique identifier for the resource. This identifier is defined by the server.

  • imageEncryptionKey (type: GoogleApi.Compute.V1.Model.CustomerEncryptionKey.t, default: nil) - Encrypts the image using a customer-supplied encryption key.

    After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

  • kind (type: String.t, default: compute#image) - [Output Only] Type of the resource. Always compute#image for images.

  • labelFingerprint (type: String.t, default: nil) - A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

    To see the latest fingerprint, make a get() request to retrieve an image.

  • labels (type: map(), default: nil) - Labels to apply to this image. These can be later modified by the setLabels method.

  • licenseCodes (type: list(String.t), default: nil) - Integer license codes indicating which licenses are attached to this image.

  • licenses (type: list(String.t), default: nil) - Any applicable license URI.

  • name (type: String.t, default: nil) - 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.

  • rawDisk (type: GoogleApi.Compute.V1.Model.ImageRawDisk.t, default: nil) - The parameters of the raw disk image.

  • satisfiesPzs (type: boolean(), default: nil) - [Output Only] Reserved for future use.

  • selfLink (type: String.t, default: nil) - [Output Only] Server-defined URL for the resource.

  • shieldedInstanceInitialState (type: GoogleApi.Compute.V1.Model.InitialStateConfig.t, default: nil) - Set the secure boot keys of shielded instance.

  • sourceDisk (type: String.t, default: nil) - URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:

  • sourceDiskEncryptionKey (type: GoogleApi.Compute.V1.Model.CustomerEncryptionKey.t, default: nil) - The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

  • sourceDiskId (type: String.t, default: nil) - [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

  • sourceImage (type: String.t, default: nil) - URL of the source image used to create this image.

    In order to create an image, you must provide the full or partial URL of one of the following:

    • The selfLink URL
    • This property
    • The rawDisk.source URL
    • The sourceDisk URL
  • sourceImageEncryptionKey (type: GoogleApi.Compute.V1.Model.CustomerEncryptionKey.t, default: nil) - The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

  • sourceImageId (type: String.t, default: nil) - [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.

  • sourceSnapshot (type: String.t, default: nil) - URL of the source snapshot used to create this image.

    In order to create an image, you must provide the full or partial URL of one of the following:

    • The selfLink URL
    • This property
    • The sourceImage URL
    • The rawDisk.source URL
    • The sourceDisk URL
  • sourceSnapshotEncryptionKey (type: GoogleApi.Compute.V1.Model.CustomerEncryptionKey.t, default: nil) - The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

  • sourceSnapshotId (type: String.t, default: nil) - [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.

  • sourceType (type: String.t, default: RAW) - The type of the image used to create this disk. The default and only value is RAW

  • status (type: String.t, default: nil) - [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

  • storageLocations (type: list(String.t), default: nil) - Cloud Storage bucket storage location of the image (regional or multi-regional).

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Compute.V1.Model.Image{
  archiveSizeBytes: String.t() | nil,
  creationTimestamp: String.t() | nil,
  deprecated: GoogleApi.Compute.V1.Model.DeprecationStatus.t() | nil,
  description: String.t() | nil,
  diskSizeGb: String.t() | nil,
  family: String.t() | nil,
  guestOsFeatures: [GoogleApi.Compute.V1.Model.GuestOsFeature.t()] | nil,
  id: String.t() | nil,
  imageEncryptionKey:
    GoogleApi.Compute.V1.Model.CustomerEncryptionKey.t() | nil,
  kind: String.t() | nil,
  labelFingerprint: String.t() | nil,
  labels: map() | nil,
  licenseCodes: [String.t()] | nil,
  licenses: [String.t()] | nil,
  name: String.t() | nil,
  rawDisk: GoogleApi.Compute.V1.Model.ImageRawDisk.t() | nil,
  satisfiesPzs: boolean() | nil,
  selfLink: String.t() | nil,
  shieldedInstanceInitialState:
    GoogleApi.Compute.V1.Model.InitialStateConfig.t() | nil,
  sourceDisk: String.t() | nil,
  sourceDiskEncryptionKey:
    GoogleApi.Compute.V1.Model.CustomerEncryptionKey.t() | nil,
  sourceDiskId: String.t() | nil,
  sourceImage: String.t() | nil,
  sourceImageEncryptionKey:
    GoogleApi.Compute.V1.Model.CustomerEncryptionKey.t() | nil,
  sourceImageId: String.t() | nil,
  sourceSnapshot: String.t() | nil,
  sourceSnapshotEncryptionKey:
    GoogleApi.Compute.V1.Model.CustomerEncryptionKey.t() | nil,
  sourceSnapshotId: String.t() | nil,
  sourceType: String.t() | nil,
  status: String.t() | nil,
  storageLocations: [String.t()] | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.