Interface SnapshotOrBuilder (1.53.0) 

public interface SnapshotOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

getArchitecture()

public abstract String getArchitecture()

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
String

The architecture.

getArchitectureBytes()

public abstract ByteString getArchitectureBytes()

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
ByteString

The bytes for architecture.

getAutoCreated()

public abstract boolean getAutoCreated()

[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

optional bool auto_created = 463922264;

Returns
Type Description
boolean

The autoCreated.

getChainName()

public abstract String getChainName()

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

optional string chain_name = 68644169;

Returns
Type Description
String

The chainName.

getChainNameBytes()

public abstract ByteString getChainNameBytes()

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

optional string chain_name = 68644169;

Returns
Type Description
ByteString

The bytes for chainName.

getCreationSizeBytes()

public abstract long getCreationSizeBytes()

[Output Only] Size in bytes of the snapshot at creation time.

optional int64 creation_size_bytes = 125400077;

Returns
Type Description
long

The creationSizeBytes.

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDescription()

public abstract String getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDiskSizeGb()

public abstract long getDiskSizeGb()

[Output Only] Size of the source disk, specified in GB.

optional int64 disk_size_gb = 316263735;

Returns
Type Description
long

The diskSizeGb.

getDownloadBytes()

public abstract long getDownloadBytes()

[Output Only] Number of bytes downloaded to restore a snapshot to a disk.

optional int64 download_bytes = 435054068;

Returns
Type Description
long

The downloadBytes.

getEnableConfidentialCompute()

public abstract boolean getEnableConfidentialCompute()

Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

optional bool enable_confidential_compute = 102135228;

Returns
Type Description
boolean

The enableConfidentialCompute.

getGuestOsFeatures(int index)

public abstract GuestOsFeature getGuestOsFeatures(int index)

[Output Only] 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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Parameter
Name Description
index int
Returns
Type Description
GuestOsFeature

getGuestOsFeaturesCount()

public abstract int getGuestOsFeaturesCount()

[Output Only] 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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
int

getGuestOsFeaturesList()

public abstract List<GuestOsFeature> getGuestOsFeaturesList()

[Output Only] 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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
List<GuestOsFeature>

getGuestOsFeaturesOrBuilder(int index)

public abstract GuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder(int index)

[Output Only] 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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Parameter
Name Description
index int
Returns
Type Description
GuestOsFeatureOrBuilder

getGuestOsFeaturesOrBuilderList()

public abstract List<? extends GuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()

[Output Only] 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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.GuestOsFeatureOrBuilder>

getId()

public abstract long getId()

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

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public abstract String getKind()

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getLabelFingerprint()

public abstract String getLabelFingerprint()

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set 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 a snapshot.

optional string label_fingerprint = 178124825;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public abstract ByteString getLabelFingerprintBytes()

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set 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 a snapshot.

optional string label_fingerprint = 178124825;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

getLicenseCodes(int index)

public abstract long getLicenseCodes(int index)

[Output Only] Integer license codes indicating which licenses are attached to this snapshot.

repeated int64 license_codes = 45482664;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The licenseCodes at the given index.

getLicenseCodesCount()

public abstract int getLicenseCodesCount()

[Output Only] Integer license codes indicating which licenses are attached to this snapshot.

repeated int64 license_codes = 45482664;

Returns
Type Description
int

The count of licenseCodes.

getLicenseCodesList()

public abstract List<Long> getLicenseCodesList()

[Output Only] Integer license codes indicating which licenses are attached to this snapshot.

repeated int64 license_codes = 45482664;

Returns
Type Description
List<Long>

A list containing the licenseCodes.

getLicenses(int index)

public abstract String getLicenses(int index)

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

repeated string licenses = 337642578;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The licenses at the given index.

getLicensesBytes(int index)

public abstract ByteString getLicensesBytes(int index)

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

repeated string licenses = 337642578;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the licenses at the given index.

getLicensesCount()

public abstract int getLicensesCount()

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

repeated string licenses = 337642578;

Returns
Type Description
int

The count of licenses.

getLicensesList()

public abstract List<String> getLicensesList()

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

repeated string licenses = 337642578;

Returns
Type Description
List<String>

A list containing the licenses.

getLocationHint()

public abstract String getLocationHint()

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.

optional string location_hint = 350519505;

Returns
Type Description
String

The locationHint.

getLocationHintBytes()

public abstract ByteString getLocationHintBytes()

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.

optional string location_hint = 350519505;

Returns
Type Description
ByteString

The bytes for locationHint.

getName()

public abstract String getName()

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

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getSatisfiesPzi()

public abstract boolean getSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

getSelfLink()

public abstract String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSnapshotEncryptionKey()

public abstract CustomerEncryptionKey getSnapshotEncryptionKey()

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

optional .google.cloud.compute.v1.CustomerEncryptionKey snapshot_encryption_key = 43334526;

Returns
Type Description
CustomerEncryptionKey

The snapshotEncryptionKey.

getSnapshotEncryptionKeyOrBuilder()

public abstract CustomerEncryptionKeyOrBuilder getSnapshotEncryptionKeyOrBuilder()

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

optional .google.cloud.compute.v1.CustomerEncryptionKey snapshot_encryption_key = 43334526;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getSnapshotType()

public abstract String getSnapshotType()

Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values.

optional string snapshot_type = 124349653;

Returns
Type Description
String

The snapshotType.

getSnapshotTypeBytes()

public abstract ByteString getSnapshotTypeBytes()

Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values.

optional string snapshot_type = 124349653;

Returns
Type Description
ByteString

The bytes for snapshotType.

getSourceDisk()

public abstract String getSourceDisk()

The source disk used to create this snapshot.

optional string source_disk = 451753793;

Returns
Type Description
String

The sourceDisk.

getSourceDiskBytes()

public abstract ByteString getSourceDiskBytes()

The source disk used to create this snapshot.

optional string source_disk = 451753793;

Returns
Type Description
ByteString

The bytes for sourceDisk.

getSourceDiskEncryptionKey()

public abstract CustomerEncryptionKey getSourceDiskEncryptionKey()

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_disk_encryption_key = 531501153;

Returns
Type Description
CustomerEncryptionKey

The sourceDiskEncryptionKey.

getSourceDiskEncryptionKeyOrBuilder()

public abstract CustomerEncryptionKeyOrBuilder getSourceDiskEncryptionKeyOrBuilder()

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_disk_encryption_key = 531501153;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getSourceDiskForRecoveryCheckpoint()

public abstract String getSourceDiskForRecoveryCheckpoint()

The source disk whose recovery checkpoint will be used to create this snapshot.

optional string source_disk_for_recovery_checkpoint = 359837950;

Returns
Type Description
String

The sourceDiskForRecoveryCheckpoint.

getSourceDiskForRecoveryCheckpointBytes()

public abstract ByteString getSourceDiskForRecoveryCheckpointBytes()

The source disk whose recovery checkpoint will be used to create this snapshot.

optional string source_disk_for_recovery_checkpoint = 359837950;

Returns
Type Description
ByteString

The bytes for sourceDiskForRecoveryCheckpoint.

getSourceDiskId()

public abstract String getSourceDiskId()

[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

optional string source_disk_id = 454190809;

Returns
Type Description
String

The sourceDiskId.

getSourceDiskIdBytes()

public abstract ByteString getSourceDiskIdBytes()

[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

optional string source_disk_id = 454190809;

Returns
Type Description
ByteString

The bytes for sourceDiskId.

getSourceInstantSnapshot()

public abstract String getSourceInstantSnapshot()

The source instant snapshot used to create this snapshot. 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 /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

optional string source_instant_snapshot = 219202054;

Returns
Type Description
String

The sourceInstantSnapshot.

getSourceInstantSnapshotBytes()

public abstract ByteString getSourceInstantSnapshotBytes()

The source instant snapshot used to create this snapshot. 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 /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

optional string source_instant_snapshot = 219202054;

Returns
Type Description
ByteString

The bytes for sourceInstantSnapshot.

getSourceInstantSnapshotEncryptionKey()

public abstract CustomerEncryptionKey getSourceInstantSnapshotEncryptionKey()

Customer provided encryption key when creating Snapshot from Instant Snapshot.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_instant_snapshot_encryption_key = 436536060;

Returns
Type Description
CustomerEncryptionKey

The sourceInstantSnapshotEncryptionKey.

getSourceInstantSnapshotEncryptionKeyOrBuilder()

public abstract CustomerEncryptionKeyOrBuilder getSourceInstantSnapshotEncryptionKeyOrBuilder()

Customer provided encryption key when creating Snapshot from Instant Snapshot.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_instant_snapshot_encryption_key = 436536060;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getSourceInstantSnapshotId()

public abstract String getSourceInstantSnapshotId()

[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.

optional string source_instant_snapshot_id = 287582708;

Returns
Type Description
String

The sourceInstantSnapshotId.

getSourceInstantSnapshotIdBytes()

public abstract ByteString getSourceInstantSnapshotIdBytes()

[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.

optional string source_instant_snapshot_id = 287582708;

Returns
Type Description
ByteString

The bytes for sourceInstantSnapshotId.

getSourceSnapshotSchedulePolicy()

public abstract String getSourceSnapshotSchedulePolicy()

[Output Only] URL of the resource policy which created this scheduled snapshot.

optional string source_snapshot_schedule_policy = 235756291;

Returns
Type Description
String

The sourceSnapshotSchedulePolicy.

getSourceSnapshotSchedulePolicyBytes()

public abstract ByteString getSourceSnapshotSchedulePolicyBytes()

[Output Only] URL of the resource policy which created this scheduled snapshot.

optional string source_snapshot_schedule_policy = 235756291;

Returns
Type Description
ByteString

The bytes for sourceSnapshotSchedulePolicy.

getSourceSnapshotSchedulePolicyId()

public abstract String getSourceSnapshotSchedulePolicyId()

[Output Only] ID of the resource policy which created this scheduled snapshot.

optional string source_snapshot_schedule_policy_id = 70489047;

Returns
Type Description
String

The sourceSnapshotSchedulePolicyId.

getSourceSnapshotSchedulePolicyIdBytes()

public abstract ByteString getSourceSnapshotSchedulePolicyIdBytes()

[Output Only] ID of the resource policy which created this scheduled snapshot.

optional string source_snapshot_schedule_policy_id = 70489047;

Returns
Type Description
ByteString

The bytes for sourceSnapshotSchedulePolicyId.

getStatus()

public abstract String getStatus()

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public abstract ByteString getStatusBytes()

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

getStorageBytes()

public abstract long getStorageBytes()

[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

optional int64 storage_bytes = 424631719;

Returns
Type Description
long

The storageBytes.

getStorageBytesStatus()

public abstract String getStorageBytesStatus()

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. Check the StorageBytesStatus enum for the list of possible values.

optional string storage_bytes_status = 490739082;

Returns
Type Description
String

The storageBytesStatus.

getStorageBytesStatusBytes()

public abstract ByteString getStorageBytesStatusBytes()

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. Check the StorageBytesStatus enum for the list of possible values.

optional string storage_bytes_status = 490739082;

Returns
Type Description
ByteString

The bytes for storageBytesStatus.

getStorageLocations(int index)

public abstract String getStorageLocations(int index)

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

repeated string storage_locations = 328005274;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The storageLocations at the given index.

getStorageLocationsBytes(int index)

public abstract ByteString getStorageLocationsBytes(int index)

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

repeated string storage_locations = 328005274;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the storageLocations at the given index.

getStorageLocationsCount()

public abstract int getStorageLocationsCount()

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

repeated string storage_locations = 328005274;

Returns
Type Description
int

The count of storageLocations.

getStorageLocationsList()

public abstract List<String> getStorageLocationsList()

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

repeated string storage_locations = 328005274;

Returns
Type Description
List<String>

A list containing the storageLocations.

hasArchitecture()

public abstract boolean hasArchitecture()

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
boolean

Whether the architecture field is set.

hasAutoCreated()

public abstract boolean hasAutoCreated()

[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

optional bool auto_created = 463922264;

Returns
Type Description
boolean

Whether the autoCreated field is set.

hasChainName()

public abstract boolean hasChainName()

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

optional string chain_name = 68644169;

Returns
Type Description
boolean

Whether the chainName field is set.

hasCreationSizeBytes()

public abstract boolean hasCreationSizeBytes()

[Output Only] Size in bytes of the snapshot at creation time.

optional int64 creation_size_bytes = 125400077;

Returns
Type Description
boolean

Whether the creationSizeBytes field is set.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public abstract boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDiskSizeGb()

public abstract boolean hasDiskSizeGb()

[Output Only] Size of the source disk, specified in GB.

optional int64 disk_size_gb = 316263735;

Returns
Type Description
boolean

Whether the diskSizeGb field is set.

hasDownloadBytes()

public abstract boolean hasDownloadBytes()

[Output Only] Number of bytes downloaded to restore a snapshot to a disk.

optional int64 download_bytes = 435054068;

Returns
Type Description
boolean

Whether the downloadBytes field is set.

hasEnableConfidentialCompute()

public abstract boolean hasEnableConfidentialCompute()

Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

optional bool enable_confidential_compute = 102135228;

Returns
Type Description
boolean

Whether the enableConfidentialCompute field is set.

hasId()

public abstract boolean hasId()

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

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public abstract boolean hasKind()

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLabelFingerprint()

public abstract boolean hasLabelFingerprint()

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set 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 a snapshot.

optional string label_fingerprint = 178124825;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasLocationHint()

public abstract boolean hasLocationHint()

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.

optional string location_hint = 350519505;

Returns
Type Description
boolean

Whether the locationHint field is set.

hasName()

public abstract boolean hasName()

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

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasSatisfiesPzi()

public abstract boolean hasSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public abstract boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasSelfLink()

public abstract boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSnapshotEncryptionKey()

public abstract boolean hasSnapshotEncryptionKey()

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

optional .google.cloud.compute.v1.CustomerEncryptionKey snapshot_encryption_key = 43334526;

Returns
Type Description
boolean

Whether the snapshotEncryptionKey field is set.

hasSnapshotType()

public abstract boolean hasSnapshotType()

Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values.

optional string snapshot_type = 124349653;

Returns
Type Description
boolean

Whether the snapshotType field is set.

hasSourceDisk()

public abstract boolean hasSourceDisk()

The source disk used to create this snapshot.

optional string source_disk = 451753793;

Returns
Type Description
boolean

Whether the sourceDisk field is set.

hasSourceDiskEncryptionKey()

public abstract boolean hasSourceDiskEncryptionKey()

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_disk_encryption_key = 531501153;

Returns
Type Description
boolean

Whether the sourceDiskEncryptionKey field is set.

hasSourceDiskForRecoveryCheckpoint()

public abstract boolean hasSourceDiskForRecoveryCheckpoint()

The source disk whose recovery checkpoint will be used to create this snapshot.

optional string source_disk_for_recovery_checkpoint = 359837950;

Returns
Type Description
boolean

Whether the sourceDiskForRecoveryCheckpoint field is set.

hasSourceDiskId()

public abstract boolean hasSourceDiskId()

[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

optional string source_disk_id = 454190809;

Returns
Type Description
boolean

Whether the sourceDiskId field is set.

hasSourceInstantSnapshot()

public abstract boolean hasSourceInstantSnapshot()

The source instant snapshot used to create this snapshot. 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 /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

optional string source_instant_snapshot = 219202054;

Returns
Type Description
boolean

Whether the sourceInstantSnapshot field is set.

hasSourceInstantSnapshotEncryptionKey()

public abstract boolean hasSourceInstantSnapshotEncryptionKey()

Customer provided encryption key when creating Snapshot from Instant Snapshot.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_instant_snapshot_encryption_key = 436536060;

Returns
Type Description
boolean

Whether the sourceInstantSnapshotEncryptionKey field is set.

hasSourceInstantSnapshotId()

public abstract boolean hasSourceInstantSnapshotId()

[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.

optional string source_instant_snapshot_id = 287582708;

Returns
Type Description
boolean

Whether the sourceInstantSnapshotId field is set.

hasSourceSnapshotSchedulePolicy()

public abstract boolean hasSourceSnapshotSchedulePolicy()

[Output Only] URL of the resource policy which created this scheduled snapshot.

optional string source_snapshot_schedule_policy = 235756291;

Returns
Type Description
boolean

Whether the sourceSnapshotSchedulePolicy field is set.

hasSourceSnapshotSchedulePolicyId()

public abstract boolean hasSourceSnapshotSchedulePolicyId()

[Output Only] ID of the resource policy which created this scheduled snapshot.

optional string source_snapshot_schedule_policy_id = 70489047;

Returns
Type Description
boolean

Whether the sourceSnapshotSchedulePolicyId field is set.

hasStatus()

public abstract boolean hasStatus()

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hasStorageBytes()

public abstract boolean hasStorageBytes()

[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

optional int64 storage_bytes = 424631719;

Returns
Type Description
boolean

Whether the storageBytes field is set.

hasStorageBytesStatus()

public abstract boolean hasStorageBytesStatus()

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. Check the StorageBytesStatus enum for the list of possible values.

optional string storage_bytes_status = 490739082;

Returns
Type Description
boolean

Whether the storageBytesStatus field is set.