Class Backup (0.54.0) 

public final class Backup extends GeneratedMessageV3 implements BackupOrBuilder

A NetApp Backup.

Protobuf type google.cloud.netapp.v1.Backup

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Backup

Implements

BackupOrBuilder

Static Fields

BACKUP_REGION_FIELD_NUMBER

public static final int BACKUP_REGION_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_TYPE_FIELD_NUMBER

public static final int BACKUP_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CHAIN_STORAGE_BYTES_FIELD_NUMBER

public static final int CHAIN_STORAGE_BYTES_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENFORCED_RETENTION_END_TIME_FIELD_NUMBER

public static final int ENFORCED_RETENTION_END_TIME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_SNAPSHOT_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_VOLUME_FIELD_NUMBER

public static final int SOURCE_VOLUME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

VOLUME_REGION_FIELD_NUMBER

public static final int VOLUME_REGION_FIELD_NUMBER
Field Value
Type Description
int

VOLUME_USAGE_BYTES_FIELD_NUMBER

public static final int VOLUME_USAGE_BYTES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Backup getDefaultInstance()
Returns
Type Description
Backup

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Backup.Builder newBuilder()
Returns
Type Description
Backup.Builder

newBuilder(Backup prototype)

public static Backup.Builder newBuilder(Backup prototype)
Parameter
Name Description
prototype Backup
Returns
Type Description
Backup.Builder

parseDelimitedFrom(InputStream input)

public static Backup parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Backup parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Backup parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Backup parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Backup parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Backup parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Backup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Backup> parser()
Returns
Type Description
Parser<Backup>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

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

getBackupRegion()

public String getBackupRegion()

Output only. Region in which backup is stored. Format: projects/{project_id}/locations/{location}

string backup_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The backupRegion.

getBackupRegionBytes()

public ByteString getBackupRegionBytes()

Output only. Region in which backup is stored. Format: projects/{project_id}/locations/{location}

string backup_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for backupRegion.

getBackupType()

public Backup.Type getBackupType()

Output only. Type of backup, manually created or created by a backup policy.

.google.cloud.netapp.v1.Backup.Type backup_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.Type

The backupType.

getBackupTypeValue()

public int getBackupTypeValue()

Output only. Type of backup, manually created or created by a backup policy.

.google.cloud.netapp.v1.Backup.Type backup_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for backupType.

getChainStorageBytes()

public long getChainStorageBytes()

Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)

int64 chain_storage_bytes = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The chainStorageBytes.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the backup was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the backup was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Backup getDefaultInstanceForType()
Returns
Type Description
Backup

getDescription()

public String getDescription()

A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getEnforcedRetentionEndTime()

public Timestamp getEnforcedRetentionEndTime()

Output only. The time until which the backup is not deletable.

.google.protobuf.Timestamp enforced_retention_end_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The enforcedRetentionEndTime.

getEnforcedRetentionEndTimeOrBuilder()

public TimestampOrBuilder getEnforcedRetentionEndTimeOrBuilder()

Output only. The time until which the backup is not deletable.

.google.protobuf.Timestamp enforced_retention_end_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Identifier. The resource name of the backup. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the backup. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Backup> getParserForType()
Returns
Type Description
Parser<Backup>
Overrides

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use

bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use

bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceSnapshot()

public String getSourceSnapshot()

If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}

optional string source_snapshot = 7 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The sourceSnapshot.

getSourceSnapshotBytes()

public ByteString getSourceSnapshotBytes()

If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}

optional string source_snapshot = 7 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for sourceSnapshot.

getSourceVolume()

public String getSourceVolume()

Volume full name of this backup belongs to. Format: projects/{projects_id}/locations/{location}/volumes/{volume_id}

string source_volume = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The sourceVolume.

getSourceVolumeBytes()

public ByteString getSourceVolumeBytes()

Volume full name of this backup belongs to. Format: projects/{projects_id}/locations/{location}/volumes/{volume_id}

string source_volume = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for sourceVolume.

getState()

public Backup.State getState()

Output only. The backup state.

.google.cloud.netapp.v1.Backup.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.State

The state.

getStateValue()

public int getStateValue()

Output only. The backup state.

.google.cloud.netapp.v1.Backup.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getVolumeRegion()

public String getVolumeRegion()

Output only. Region of the volume from which the backup was created. Format: projects/{project_id}/locations/{location}

string volume_region = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The volumeRegion.

getVolumeRegionBytes()

public ByteString getVolumeRegionBytes()

Output only. Region of the volume from which the backup was created. Format: projects/{project_id}/locations/{location}

string volume_region = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for volumeRegion.

getVolumeUsageBytes()

public long getVolumeUsageBytes()

Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.

int64 volume_usage_bytes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The volumeUsageBytes.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the backup was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEnforcedRetentionEndTime()

public boolean hasEnforcedRetentionEndTime()

Output only. The time until which the backup is not deletable.

.google.protobuf.Timestamp enforced_retention_end_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the enforcedRetentionEndTime field is set.

hasSourceSnapshot()

public boolean hasSourceSnapshot()

If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}

optional string source_snapshot = 7 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the sourceSnapshot field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Backup.Builder newBuilderForType()
Returns
Type Description
Backup.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Backup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Backup.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Backup.Builder toBuilder()
Returns
Type Description
Backup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException