REST Resource: imageFamilyViews

Resource: ImageFamilyViewsGetResponse

JSON representation
{
  "resource": {
    "image": {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "sourceType": enum,
      "rawDisk": {
        "source": string,
        "sha1Checksum": string,
        "containerType": enum
      },
      "deprecated": {
        "state": enum,
        "replacement": string,
        "deprecated": string,
        "obsolete": string,
        "deleted": string,
        "stateOverride": {
          "locationRolloutPolicies": {
            string: string,
            ...
          },
          "defaultRolloutTime": string
        }
      },
      "status": enum,
      "archiveSizeBytes": string,
      "diskSizeGb": string,
      "sourceDisk": string,
      "sourceDiskId": string,
      "licenses": [
        string
      ],
      "family": string,
      "imageEncryptionKey": {
        "rawKey": string,
        "rsaEncryptedKey": string,
        "kmsKeyName": string,
        "sha256": string,
        "kmsKeyServiceAccount": string
      },
      "sourceDiskEncryptionKey": {
        "rawKey": string,
        "rsaEncryptedKey": string,
        "kmsKeyName": string,
        "sha256": string,
        "kmsKeyServiceAccount": string
      },
      "selfLink": string,
      "labels": {
        string: string,
        ...
      },
      "labelFingerprint": string,
      "guestOsFeatures": [
        {
          "type": enum
        }
      ],
      "licenseCodes": [
        string
      ],
      "sourceImage": string,
      "sourceImageId": string,
      "sourceImageEncryptionKey": {
        "rawKey": string,
        "rsaEncryptedKey": string,
        "kmsKeyName": string,
        "sha256": string,
        "kmsKeyServiceAccount": string
      },
      "sourceSnapshot": string,
      "sourceSnapshotId": string,
      "sourceSnapshotEncryptionKey": {
        "rawKey": string,
        "rsaEncryptedKey": string,
        "kmsKeyName": string,
        "sha256": string,
        "kmsKeyServiceAccount": string
      },
      "storageLocations": [
        string
      ],
      "shieldedInstanceInitialState": {
        "pk": {
          "content": string,
          "fileType": enum
        },
        "keks": [
          {
            "content": string,
            "fileType": enum
          }
        ],
        "dbs": [
          {
            "content": string,
            "fileType": enum
          }
        ],
        "dbxs": [
          {
            "content": string,
            "fileType": enum
          }
        ]
      },
      "rolloutOverride": {
        "locationRolloutPolicies": {
          string: string,
          ...
        },
        "defaultRolloutTime": string
      },
      "satisfiesPzs": boolean,
      "locked": boolean,
      "userLicenses": [
        string
      ],
      "kind": string
    }
  }
}
Fields
resource

object

resource.image

object

The latest image that is part of the specified image family in the requested location, and that is not deprecated.

resource.image.id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

resource.image.creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

resource.image.name

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.

resource.image.description

string

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

resource.image.sourceType

enum

The type of the image used to create this disk. The default and only value is RAW

resource.image.rawDisk

object

The parameters of the raw disk image.

resource.image.rawDisk.source

string

The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL:

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

  • The rawDisk.source URL
  • The sourceDisk URL
  • The sourceImage URL
  • The sourceSnapshot URL

resource.image.rawDisk.sha1Checksum
(deprecated)

string

[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.

resource.image.rawDisk.containerType

enum

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

resource.image.deprecated

object

The deprecation status associated with this image.

resource.image.deprecated.state

enum

The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

resource.image.deprecated.replacement

string

The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

resource.image.deprecated.deprecated

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

resource.image.deprecated.obsolete

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

resource.image.deprecated.deleted

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

resource.image.deprecated.stateOverride

object

The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state.

The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

resource.image.deprecated.stateOverride.locationRolloutPolicies

map (key: string, value: string)

Location based rollout policies to apply to the resource.

Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

resource.image.deprecated.stateOverride.defaultRolloutTime

string

An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

resource.image.status

enum

[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.

resource.image.archiveSizeBytes

string (int64 format)

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

resource.image.diskSizeGb

string (int64 format)

Size of the image when restored onto a persistent disk (in GB).

resource.image.sourceDisk

string

URL of the source disk used to create this image. For example, the following are valid values: