Class Snapshot.Builder (1.51.0)

Version 1.51.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public static final class Snapshot.Builder extends GeneratedMessageV3.Builder<Snapshot.Builder> implements SnapshotOrBuilder

Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.

Protobuf type google.cloud.compute.v1.Snapshot

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Snapshot.Builder

Implements

SnapshotOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllGuestOsFeatures(Iterable<? extends GuestOsFeature> values)

public Snapshot.Builder addAllGuestOsFeatures(Iterable<? extends GuestOsFeature> values)

[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
values	Iterable<? extends com.google.cloud.compute.v1.GuestOsFeature>

Returns
Type	Description
Snapshot.Builder

addAllLicenseCodes(Iterable<? extends Long> values)

public Snapshot.Builder addAllLicenseCodes(Iterable<? extends Long> values)

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

repeated int64 license_codes = 45482664;

Parameter
Name	Description
values	Iterable<? extends java.lang.Long> The licenseCodes to add.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

addAllLicenses(Iterable<String> values)

public Snapshot.Builder addAllLicenses(Iterable<String> values)

[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
values	Iterable<String> The licenses to add.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

addAllStorageLocations(Iterable<String> values)

public Snapshot.Builder addAllStorageLocations(Iterable<String> values)

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

repeated string storage_locations = 328005274;

Parameter
Name	Description
values	Iterable<String> The storageLocations to add.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

addGuestOsFeatures(GuestOsFeature value)

public Snapshot.Builder addGuestOsFeatures(GuestOsFeature value)

[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
value	GuestOsFeature

Returns
Type	Description
Snapshot.Builder

addGuestOsFeatures(GuestOsFeature.Builder builderForValue)

public Snapshot.Builder addGuestOsFeatures(GuestOsFeature.Builder builderForValue)

[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
builderForValue	GuestOsFeature.Builder

Returns
Type	Description
Snapshot.Builder

addGuestOsFeatures(int index, GuestOsFeature value)

public Snapshot.Builder addGuestOsFeatures(int index, GuestOsFeature value)

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

Parameters
Name	Description
index	int
value	GuestOsFeature

Returns
Type	Description
Snapshot.Builder

addGuestOsFeatures(int index, GuestOsFeature.Builder builderForValue)

public Snapshot.Builder addGuestOsFeatures(int index, GuestOsFeature.Builder builderForValue)

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

Parameters
Name	Description
index	int
builderForValue	GuestOsFeature.Builder

Returns
Type	Description
Snapshot.Builder

addGuestOsFeaturesBuilder()

public GuestOsFeature.Builder addGuestOsFeaturesBuilder()

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

addGuestOsFeaturesBuilder(int index)

public GuestOsFeature.Builder addGuestOsFeaturesBuilder(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.Builder

addLicenseCodes(long value)

public Snapshot.Builder addLicenseCodes(long value)

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

repeated int64 license_codes = 45482664;

Parameter
Name	Description
value	long The licenseCodes to add.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

addLicenses(String value)

public Snapshot.Builder addLicenses(String value)

[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
value	String The licenses to add.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

addLicensesBytes(ByteString value)

public Snapshot.Builder addLicensesBytes(ByteString value)

[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
value	ByteString The bytes of the licenses to add.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addStorageLocations(String value)

public Snapshot.Builder addStorageLocations(String value)

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

repeated string storage_locations = 328005274;

Parameter
Name	Description
value	String The storageLocations to add.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

addStorageLocationsBytes(ByteString value)

public Snapshot.Builder addStorageLocationsBytes(ByteString value)

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

repeated string storage_locations = 328005274;

Parameter
Name	Description
value	ByteString The bytes of the storageLocations to add.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

build()

public Snapshot build()

Returns
Type	Description
Snapshot

buildPartial()

public Snapshot buildPartial()

Returns
Type	Description
Snapshot

clear()

public Snapshot.Builder clear()

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearArchitecture()

public Snapshot.Builder clearArchitecture()

[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
Snapshot.Builder	This builder for chaining.

clearAutoCreated()

public Snapshot.Builder clearAutoCreated()

[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
Snapshot.Builder	This builder for chaining.

clearChainName()

public Snapshot.Builder clearChainName()

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
Snapshot.Builder	This builder for chaining.

clearCreationSizeBytes()

public Snapshot.Builder clearCreationSizeBytes()

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

optional int64 creation_size_bytes = 125400077;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearCreationTimestamp()

public Snapshot.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearDescription()

public Snapshot.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearDiskSizeGb()

public Snapshot.Builder clearDiskSizeGb()

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

optional int64 disk_size_gb = 316263735;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearDownloadBytes()

public Snapshot.Builder clearDownloadBytes()

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

optional int64 download_bytes = 435054068;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearEnableConfidentialCompute()

public Snapshot.Builder clearEnableConfidentialCompute()

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
Snapshot.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Snapshot.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGuestOsFeatures()

public Snapshot.Builder clearGuestOsFeatures()

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

clearId()

public Snapshot.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearKind()

public Snapshot.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearLabelFingerprint()

public Snapshot.Builder clearLabelFingerprint()

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
Snapshot.Builder	This builder for chaining.

clearLabels()

public Snapshot.Builder clearLabels()

Returns
Type	Description
Snapshot.Builder

clearLicenseCodes()

public Snapshot.Builder clearLicenseCodes()

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

repeated int64 license_codes = 45482664;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearLicenses()

public Snapshot.Builder clearLicenses()

[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
Snapshot.Builder	This builder for chaining.

clearLocationHint()

public Snapshot.Builder clearLocationHint()

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
Snapshot.Builder	This builder for chaining.

clearName()

public Snapshot.Builder clearName()

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
Snapshot.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Snapshot.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSatisfiesPzi()

public Snapshot.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearSatisfiesPzs()

public Snapshot.Builder clearSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearSelfLink()

public Snapshot.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearSnapshotEncryptionKey()

public Snapshot.Builder clearSnapshotEncryptionKey()

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
Snapshot.Builder

clearSnapshotType()

public Snapshot.Builder clearSnapshotType()

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

optional string snapshot_type = 124349653;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearSourceDisk()

public Snapshot.Builder clearSourceDisk()

The source disk used to create this snapshot.

optional string source_disk = 451753793;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearSourceDiskEncryptionKey()

public Snapshot.Builder clearSourceDiskEncryptionKey()

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
Snapshot.Builder

clearSourceDiskForRecoveryCheckpoint()

public Snapshot.Builder clearSourceDiskForRecoveryCheckpoint()

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

optional string source_disk_for_recovery_checkpoint = 359837950;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearSourceDiskId()

public Snapshot.Builder clearSourceDiskId()

[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
Snapshot.Builder	This builder for chaining.

clearSourceInstantSnapshot()

public Snapshot.Builder clearSourceInstantSnapshot()

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
Snapshot.Builder	This builder for chaining.

clearSourceInstantSnapshotEncryptionKey()

public Snapshot.Builder clearSourceInstantSnapshotEncryptionKey()

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
Snapshot.Builder

clearSourceInstantSnapshotId()

public Snapshot.Builder clearSourceInstantSnapshotId()

[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
Snapshot.Builder	This builder for chaining.

clearSourceSnapshotSchedulePolicy()

public Snapshot.Builder clearSourceSnapshotSchedulePolicy()

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

optional string source_snapshot_schedule_policy = 235756291;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearSourceSnapshotSchedulePolicyId()

public Snapshot.Builder clearSourceSnapshotSchedulePolicyId()

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

optional string source_snapshot_schedule_policy_id = 70489047;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clearStatus()

public Snapshot.Builder clearStatus()

[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
Snapshot.Builder	This builder for chaining.

clearStorageBytes()

public Snapshot.Builder clearStorageBytes()

[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
Snapshot.Builder	This builder for chaining.

clearStorageBytesStatus()

public Snapshot.Builder clearStorageBytesStatus()

[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
Snapshot.Builder	This builder for chaining.

clearStorageLocations()

public Snapshot.Builder clearStorageLocations()

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

repeated string storage_locations = 328005274;

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

clone()

public Snapshot.Builder clone()

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public 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 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 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 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 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 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 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 String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
ByteString	The bytes for creationTimestamp.

getDefaultInstanceForType()

public Snapshot getDefaultInstanceForType()

Returns
Type	Description
Snapshot

getDescription()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDiskSizeGb()

public 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 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 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 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

getGuestOsFeaturesBuilder(int index)

public GuestOsFeature.Builder getGuestOsFeaturesBuilder(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.Builder

getGuestOsFeaturesBuilderList()

public List<GuestOsFeature.Builder> getGuestOsFeaturesBuilderList()

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

getGuestOsFeaturesCount()

public 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 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 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 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 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 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 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public 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 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 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 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList	A list containing the licenses.

getLocationHint()

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public 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 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 boolean getSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type	Description
boolean	The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type	Description
boolean	The satisfiesPzs.

getSelfLink()

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type	Description
String	The selfLink.

getSelfLinkBytes()

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

getSnapshotEncryptionKeyBuilder()

public CustomerEncryptionKey.Builder getSnapshotEncryptionKeyBuilder()

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

getSnapshotEncryptionKeyOrBuilder()

public 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 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 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 String getSourceDisk()

The source disk used to create this snapshot.

optional string source_disk = 451753793;

Returns
Type	Description
String	The sourceDisk.

getSourceDiskBytes()

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

getSourceDiskEncryptionKeyBuilder()

public CustomerEncryptionKey.Builder getSourceDiskEncryptionKeyBuilder()

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

getSourceDiskEncryptionKeyOrBuilder()

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

getSourceInstantSnapshotEncryptionKeyBuilder()

public CustomerEncryptionKey.Builder getSourceInstantSnapshotEncryptionKeyBuilder()

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

getSourceInstantSnapshotEncryptionKeyOrBuilder()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 ProtocolStringList getStorageLocationsList()

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

repeated string storage_locations = 328005274;

Returns
Type	Description
ProtocolStringList	A list containing the storageLocations.

hasArchitecture()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Snapshot other)

public Snapshot.Builder mergeFrom(Snapshot other)

Parameter
Name	Description
other	Snapshot

Returns
Type	Description
Snapshot.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Snapshot.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Snapshot.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Snapshot.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Snapshot.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSnapshotEncryptionKey(CustomerEncryptionKey value)

public Snapshot.Builder mergeSnapshotEncryptionKey(CustomerEncryptionKey value)

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;

Parameter
Name	Description
value	CustomerEncryptionKey

Returns
Type	Description
Snapshot.Builder

mergeSourceDiskEncryptionKey(CustomerEncryptionKey value)

public Snapshot.Builder mergeSourceDiskEncryptionKey(CustomerEncryptionKey value)

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;

Parameter
Name	Description
value	CustomerEncryptionKey

Returns
Type	Description
Snapshot.Builder

mergeSourceInstantSnapshotEncryptionKey(CustomerEncryptionKey value)

public Snapshot.Builder mergeSourceInstantSnapshotEncryptionKey(CustomerEncryptionKey value)

Customer provided encryption key when creating Snapshot from Instant Snapshot.

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

Parameter
Name	Description
value	CustomerEncryptionKey

Returns
Type	Description
Snapshot.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllLabels(Map<String,String> values)

public Snapshot.Builder putAllLabels(Map<String,String> values)

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
values	Map<String,String>

Returns
Type	Description
Snapshot.Builder

putLabels(String key, String value)

public Snapshot.Builder putLabels(String key, String value)

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
value	String

Returns
Type	Description
Snapshot.Builder

removeGuestOsFeatures(int index)

public Snapshot.Builder removeGuestOsFeatures(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
Snapshot.Builder

removeLabels(String key)

public Snapshot.Builder removeLabels(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
Snapshot.Builder

setArchitecture(String value)

public Snapshot.Builder setArchitecture(String value)

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

Parameter
Name	Description
value	String The architecture to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setArchitectureBytes(ByteString value)

public Snapshot.Builder setArchitectureBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for architecture to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setAutoCreated(boolean value)

public Snapshot.Builder setAutoCreated(boolean value)

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

optional bool auto_created = 463922264;

Parameter
Name	Description
value	boolean The autoCreated to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setChainName(String value)

public Snapshot.Builder setChainName(String value)

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;

Parameter
Name	Description
value	String The chainName to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setChainNameBytes(ByteString value)

public Snapshot.Builder setChainNameBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for chainName to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setCreationSizeBytes(long value)

public Snapshot.Builder setCreationSizeBytes(long value)

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

optional int64 creation_size_bytes = 125400077;

Parameter
Name	Description
value	long The creationSizeBytes to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setCreationTimestamp(String value)

public Snapshot.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name	Description
value	String The creationTimestamp to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Snapshot.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name	Description
value	ByteString The bytes for creationTimestamp to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setDescription(String value)

public Snapshot.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Snapshot.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setDiskSizeGb(long value)

public Snapshot.Builder setDiskSizeGb(long value)

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

optional int64 disk_size_gb = 316263735;

Parameter
Name	Description
value	long The diskSizeGb to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setDownloadBytes(long value)

public Snapshot.Builder setDownloadBytes(long value)

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

optional int64 download_bytes = 435054068;

Parameter
Name	Description
value	long The downloadBytes to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setEnableConfidentialCompute(boolean value)

public Snapshot.Builder setEnableConfidentialCompute(boolean value)

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;

Parameter
Name	Description
value	boolean The enableConfidentialCompute to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGuestOsFeatures(int index, GuestOsFeature value)

public Snapshot.Builder setGuestOsFeatures(int index, GuestOsFeature value)

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

Parameters
Name	Description
index	int
value	GuestOsFeature

Returns
Type	Description
Snapshot.Builder

setGuestOsFeatures(int index, GuestOsFeature.Builder builderForValue)

public Snapshot.Builder setGuestOsFeatures(int index, GuestOsFeature.Builder builderForValue)

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

Parameters
Name	Description
index	int
builderForValue	GuestOsFeature.Builder

Returns
Type	Description
Snapshot.Builder

setId(long value)

public Snapshot.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
Name	Description
value	long The id to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setKind(String value)

public Snapshot.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
Name	Description
value	String The kind to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setKindBytes(ByteString value)

public Snapshot.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
Name	Description
value	ByteString The bytes for kind to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setLabelFingerprint(String value)

public Snapshot.Builder setLabelFingerprint(String value)

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;

Parameter
Name	Description
value	String The labelFingerprint to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setLabelFingerprintBytes(ByteString value)

public Snapshot.Builder setLabelFingerprintBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for labelFingerprint to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setLicenseCodes(int index, long value)

public Snapshot.Builder setLicenseCodes(int index, long value)

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

repeated int64 license_codes = 45482664;

Parameters
Name	Description
index	int The index to set the value at.
value	long The licenseCodes to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setLicenses(int index, String value)

public Snapshot.Builder setLicenses(int index, String value)

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

Parameters
Name	Description
index	int The index to set the value at.
value	String The licenses to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setLocationHint(String value)

public Snapshot.Builder setLocationHint(String value)

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;

Parameter
Name	Description
value	String The locationHint to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setLocationHintBytes(ByteString value)

public Snapshot.Builder setLocationHintBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for locationHint to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setName(String value)

public Snapshot.Builder setName(String value)

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;

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Snapshot.Builder setNameBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Snapshot.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSatisfiesPzi(boolean value)

public Snapshot.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Parameter
Name	Description
value	boolean The satisfiesPzi to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSatisfiesPzs(boolean value)

public Snapshot.Builder setSatisfiesPzs(boolean value)

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Parameter
Name	Description
value	boolean The satisfiesPzs to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSelfLink(String value)

public Snapshot.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name	Description
value	String The selfLink to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSelfLinkBytes(ByteString value)

public Snapshot.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name	Description
value	ByteString The bytes for selfLink to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSnapshotEncryptionKey(CustomerEncryptionKey value)

public Snapshot.Builder setSnapshotEncryptionKey(CustomerEncryptionKey value)

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;

Parameter
Name	Description
value	CustomerEncryptionKey

Returns
Type	Description
Snapshot.Builder

setSnapshotEncryptionKey(CustomerEncryptionKey.Builder builderForValue)

public Snapshot.Builder setSnapshotEncryptionKey(CustomerEncryptionKey.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	CustomerEncryptionKey.Builder

Returns
Type	Description
Snapshot.Builder

setSnapshotType(String value)

public Snapshot.Builder setSnapshotType(String value)

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

optional string snapshot_type = 124349653;

Parameter
Name	Description
value	String The snapshotType to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSnapshotTypeBytes(ByteString value)

public Snapshot.Builder setSnapshotTypeBytes(ByteString value)

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

optional string snapshot_type = 124349653;

Parameter
Name	Description
value	ByteString The bytes for snapshotType to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceDisk(String value)

public Snapshot.Builder setSourceDisk(String value)

The source disk used to create this snapshot.

optional string source_disk = 451753793;

Parameter
Name	Description
value	String The sourceDisk to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceDiskBytes(ByteString value)

public Snapshot.Builder setSourceDiskBytes(ByteString value)

The source disk used to create this snapshot.

optional string source_disk = 451753793;

Parameter
Name	Description
value	ByteString The bytes for sourceDisk to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceDiskEncryptionKey(CustomerEncryptionKey value)

public Snapshot.Builder setSourceDiskEncryptionKey(CustomerEncryptionKey value)

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;

Parameter
Name	Description
value	CustomerEncryptionKey

Returns
Type	Description
Snapshot.Builder

setSourceDiskEncryptionKey(CustomerEncryptionKey.Builder builderForValue)

public Snapshot.Builder setSourceDiskEncryptionKey(CustomerEncryptionKey.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	CustomerEncryptionKey.Builder

Returns
Type	Description
Snapshot.Builder

setSourceDiskForRecoveryCheckpoint(String value)

public Snapshot.Builder setSourceDiskForRecoveryCheckpoint(String value)

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

optional string source_disk_for_recovery_checkpoint = 359837950;

Parameter
Name	Description
value	String The sourceDiskForRecoveryCheckpoint to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceDiskForRecoveryCheckpointBytes(ByteString value)

public Snapshot.Builder setSourceDiskForRecoveryCheckpointBytes(ByteString value)

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

optional string source_disk_for_recovery_checkpoint = 359837950;

Parameter
Name	Description
value	ByteString The bytes for sourceDiskForRecoveryCheckpoint to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceDiskId(String value)

public Snapshot.Builder setSourceDiskId(String value)

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

Parameter
Name	Description
value	String The sourceDiskId to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceDiskIdBytes(ByteString value)

public Snapshot.Builder setSourceDiskIdBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for sourceDiskId to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceInstantSnapshot(String value)

public Snapshot.Builder setSourceInstantSnapshot(String value)

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;

Parameter
Name	Description
value	String The sourceInstantSnapshot to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceInstantSnapshotBytes(ByteString value)

public Snapshot.Builder setSourceInstantSnapshotBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for sourceInstantSnapshot to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceInstantSnapshotEncryptionKey(CustomerEncryptionKey value)

public Snapshot.Builder setSourceInstantSnapshotEncryptionKey(CustomerEncryptionKey value)

Customer provided encryption key when creating Snapshot from Instant Snapshot.

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

Parameter
Name	Description
value	CustomerEncryptionKey

Returns
Type	Description
Snapshot.Builder

setSourceInstantSnapshotEncryptionKey(CustomerEncryptionKey.Builder builderForValue)

public Snapshot.Builder setSourceInstantSnapshotEncryptionKey(CustomerEncryptionKey.Builder builderForValue)

Customer provided encryption key when creating Snapshot from Instant Snapshot.

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

Parameter
Name	Description
builderForValue	CustomerEncryptionKey.Builder

Returns
Type	Description
Snapshot.Builder

setSourceInstantSnapshotId(String value)

public Snapshot.Builder setSourceInstantSnapshotId(String value)

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

Parameter
Name	Description
value	String The sourceInstantSnapshotId to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceInstantSnapshotIdBytes(ByteString value)

public Snapshot.Builder setSourceInstantSnapshotIdBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for sourceInstantSnapshotId to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceSnapshotSchedulePolicy(String value)

public Snapshot.Builder setSourceSnapshotSchedulePolicy(String value)

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

optional string source_snapshot_schedule_policy = 235756291;

Parameter
Name	Description
value	String The sourceSnapshotSchedulePolicy to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceSnapshotSchedulePolicyBytes(ByteString value)

public Snapshot.Builder setSourceSnapshotSchedulePolicyBytes(ByteString value)

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

optional string source_snapshot_schedule_policy = 235756291;

Parameter
Name	Description
value	ByteString The bytes for sourceSnapshotSchedulePolicy to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceSnapshotSchedulePolicyId(String value)

public Snapshot.Builder setSourceSnapshotSchedulePolicyId(String value)

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

optional string source_snapshot_schedule_policy_id = 70489047;

Parameter
Name	Description
value	String The sourceSnapshotSchedulePolicyId to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setSourceSnapshotSchedulePolicyIdBytes(ByteString value)

public Snapshot.Builder setSourceSnapshotSchedulePolicyIdBytes(ByteString value)

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

optional string source_snapshot_schedule_policy_id = 70489047;

Parameter
Name	Description
value	ByteString The bytes for sourceSnapshotSchedulePolicyId to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setStatus(String value)

public Snapshot.Builder setStatus(String value)

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

Parameter
Name	Description
value	String The status to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setStatusBytes(ByteString value)

public Snapshot.Builder setStatusBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for status to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setStorageBytes(long value)

public Snapshot.Builder setStorageBytes(long value)

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

Parameter
Name	Description
value	long The storageBytes to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setStorageBytesStatus(String value)

public Snapshot.Builder setStorageBytesStatus(String value)

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

Parameter
Name	Description
value	String The storageBytesStatus to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setStorageBytesStatusBytes(ByteString value)

public Snapshot.Builder setStorageBytesStatusBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for storageBytesStatus to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setStorageLocations(int index, String value)

public Snapshot.Builder setStorageLocations(int index, String value)

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

repeated string storage_locations = 328005274;

Parameters
Name	Description
index	int The index to set the value at.
value	String The storageLocations to set.

Returns
Type	Description
Snapshot.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)