Class Backup (1.46.0)

public final class Backup extends GeneratedMessageV3 implements BackupOrBuilder

A Filestore backup.

Protobuf type google.cloud.filestore.v1beta1.Backup

Inheritance

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

Implements

BackupOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

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)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

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)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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

CAPACITY_GB_FIELD_NUMBER

public static final int CAPACITY_GB_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`

DOWNLOAD_BYTES_FIELD_NUMBER

public static final int DOWNLOAD_BYTES_FIELD_NUMBER

Field Value
Type	Description
`int`

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_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_FILE_SHARE_FIELD_NUMBER

public static final int SOURCE_FILE_SHARE_FIELD_NUMBER

Field Value
Type	Description
`int`

SOURCE_INSTANCE_FIELD_NUMBER

public static final int SOURCE_INSTANCE_FIELD_NUMBER

Field Value
Type	Description
`int`

SOURCE_INSTANCE_TIER_FIELD_NUMBER

public static final int SOURCE_INSTANCE_TIER_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

STORAGE_BYTES_FIELD_NUMBER

public static final int STORAGE_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 = 5;

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)

getCapacityGb()

public long getCapacityGb()

Output only. Capacity of the source file share when the backup was created.

int64 capacity_gb = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The capacityGb.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the backup was created.

.google.protobuf.Timestamp create_time = 4 [(.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 = 4 [(.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 = 2;

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 = 2;

Returns
Type	Description
`ByteString`	The bytes for description.

getDownloadBytes()

public long getDownloadBytes()

Output only. Amount of bytes that will be downloaded if the backup is restored

int64 download_bytes = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The downloadBytes.

getKmsKeyName()

public String getKmsKeyName()

Immutable. KMS key name used for data encryption.

string kms_key_name = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`String`	The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Immutable. KMS key name used for data encryption.

string kms_key_name = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`ByteString`	The bytes for kmsKeyName.

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 = 5;

Returns
Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

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 = 5;

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 = 5;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getName()

public String getName()

Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.

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

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.

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

Returns
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<Backup> getParserForType()

Returns
Type	Description
`Parser<Backup>`

Overrides

GeneratedMessageV3.getParserForType()

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

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

Returns
Type	Description
`boolean`	The satisfiesPzi.

getSatisfiesPzs()

public BoolValue getSatisfiesPzs()

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BoolValue`	The satisfiesPzs.

getSatisfiesPzsOrBuilder()

public BoolValueOrBuilder getSatisfiesPzsOrBuilder()

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BoolValueOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getSourceFileShare()

public String getSourceFileShare()

Name of the file share in the source Filestore instance that the backup is created from.

string source_file_share = 9;

Returns
Type	Description
`String`	The sourceFileShare.

getSourceFileShareBytes()

public ByteString getSourceFileShareBytes()

Name of the file share in the source Filestore instance that the backup is created from.

string source_file_share = 9;

Returns
Type	Description
`ByteString`	The bytes for sourceFileShare.

getSourceInstance()

public String getSourceInstance()

The resource name of the source Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.

string source_instance = 8 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The sourceInstance.

getSourceInstanceBytes()

public ByteString getSourceInstanceBytes()

The resource name of the source Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.

string source_instance = 8 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for sourceInstance.

getSourceInstanceTier()

public Instance.Tier getSourceInstanceTier()

Output only. The service tier of the source Filestore instance that this backup is created from.

.google.cloud.filestore.v1beta1.Instance.Tier source_instance_tier = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Instance.Tier`	The sourceInstanceTier.

getSourceInstanceTierValue()

public int getSourceInstanceTierValue()

Output only. The service tier of the source Filestore instance that this backup is created from.

.google.cloud.filestore.v1beta1.Instance.Tier source_instance_tier = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for sourceInstanceTier.

getState()

public Backup.State getState()

Output only. The backup state.

.google.cloud.filestore.v1beta1.Backup.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Backup.State`	The state.

getStateValue()

public int getStateValue()

Output only. The backup state.

.google.cloud.filestore.v1beta1.Backup.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for state.

getStorageBytes()

public long getStorageBytes()

Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

int64 storage_bytes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The storageBytes.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the backup was created.

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

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

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

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

GeneratedMessageV3.isInitialized()

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

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 Backup.Builder toBuilder()

Returns
Type	Description
`Backup.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`