Class Snapshot (1.27.0)

public final class Snapshot extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Snapshot

Implements

SnapshotOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ARCHITECTURE_FIELD_NUMBER

public static final int ARCHITECTURE_FIELD_NUMBER

Field Value
Type	Description
`int`

AUTO_CREATED_FIELD_NUMBER

public static final int AUTO_CREATED_FIELD_NUMBER

Field Value
Type	Description
`int`

CHAIN_NAME_FIELD_NUMBER

public static final int CHAIN_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

CREATION_SIZE_BYTES_FIELD_NUMBER

public static final int CREATION_SIZE_BYTES_FIELD_NUMBER

Field Value
Type	Description
`int`

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER

Field Value
Type	Description
`int`

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DISK_SIZE_GB_FIELD_NUMBER

public static final int DISK_SIZE_GB_FIELD_NUMBER

Field Value
Type	Description
`int`

DOWNLOAD_BYTES_FIELD_NUMBER

public static final int DOWNLOAD_BYTES_FIELD_NUMBER

Field Value
Type	Description
`int`

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value
Type	Description
`int`

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

Field Value
Type	Description
`int`

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value
Type	Description
`int`

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER

Field Value
Type	Description
`int`

LICENSES_FIELD_NUMBER

public static final int LICENSES_FIELD_NUMBER

Field Value
Type	Description
`int`

LICENSE_CODES_FIELD_NUMBER

public static final int LICENSE_CODES_FIELD_NUMBER

Field Value
Type	Description
`int`

LOCATION_HINT_FIELD_NUMBER

public static final int LOCATION_HINT_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER

Field Value
Type	Description
`int`

SELF_LINK_FIELD_NUMBER

public static final int SELF_LINK_FIELD_NUMBER

Field Value
Type	Description
`int`

SNAPSHOT_ENCRYPTION_KEY_FIELD_NUMBER

public static final int SNAPSHOT_ENCRYPTION_KEY_FIELD_NUMBER

Field Value
Type	Description
`int`

SNAPSHOT_TYPE_FIELD_NUMBER

public static final int SNAPSHOT_TYPE_FIELD_NUMBER

Field Value
Type	Description
`int`

SOURCE_DISK_ENCRYPTION_KEY_FIELD_NUMBER

public static final int SOURCE_DISK_ENCRYPTION_KEY_FIELD_NUMBER

Field Value
Type	Description
`int`

SOURCE_DISK_FIELD_NUMBER

public static final int SOURCE_DISK_FIELD_NUMBER

Field Value
Type	Description
`int`

SOURCE_DISK_ID_FIELD_NUMBER

public static final int SOURCE_DISK_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

SOURCE_SNAPSHOT_SCHEDULE_POLICY_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_SCHEDULE_POLICY_FIELD_NUMBER

Field Value
Type	Description
`int`

SOURCE_SNAPSHOT_SCHEDULE_POLICY_ID_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_SCHEDULE_POLICY_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

Field Value
Type	Description
`int`

STORAGE_BYTES_FIELD_NUMBER

public static final int STORAGE_BYTES_FIELD_NUMBER

Field Value
Type	Description
`int`

STORAGE_BYTES_STATUS_FIELD_NUMBER

public static final int STORAGE_BYTES_STATUS_FIELD_NUMBER

Field Value
Type	Description
`int`

STORAGE_LOCATIONS_FIELD_NUMBER

public static final int STORAGE_LOCATIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Snapshot getDefaultInstance()

Returns
Type	Description
`Snapshot`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Snapshot.Builder newBuilder()

Returns
Type	Description
`Snapshot.Builder`

newBuilder(Snapshot prototype)

public static Snapshot.Builder newBuilder(Snapshot prototype)

Parameter
Name	Description
`prototype`	`Snapshot`

Returns
Type	Description
`Snapshot.Builder`

parseDelimitedFrom(InputStream input)

public static Snapshot parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Snapshot parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Snapshot parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Snapshot parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Snapshot parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Snapshot parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Snapshot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Snapshot> parser()

Returns
Type	Description
`Parser<Snapshot>`

Methods

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`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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()

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.

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.

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()

optional string label_fingerprint = 178124825;

Returns
Type	Description
`ByteString`	The bytes for labelFingerprint.

getLabels()

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.

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()

optional string name = 3373707;

Returns
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<Snapshot> getParserForType()

Returns
Type	Description
`Parser<Snapshot>`

Overrides

GeneratedMessageV3.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.

getSnapshotEncryptionKeyOrBuilder()

public CustomerEncryptionKeyOrBuilder getSnapshotEncryptionKeyOrBuilder()

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.

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`

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.

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()

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

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()

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.

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()

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()

optional string name = 3373707;

Returns
Type	Description
`boolean`	Whether the name 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()

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.

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.

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()

optional string storage_bytes_status = 490739082;

Returns
Type	Description
`boolean`	Whether the storageBytesStatus field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Snapshot.Builder newBuilderForType()

Returns
Type	Description
`Snapshot.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Snapshot.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Snapshot.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Snapshot.Builder toBuilder()

Returns
Type	Description
`Snapshot.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`