Class Backup.Builder (1.6.0) 

public static final class Backup.Builder extends GeneratedMessageV3.Builder<Backup.Builder> implements BackupOrBuilder

A Cloud Filestore backup.

Protobuf type google.cloud.filestore.v1beta1.Backup

Inheritance

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

Implements

BackupOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Backup.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Backup.Builder
Overrides

build()

public Backup build()
Returns
Type Description
Backup

buildPartial()

public Backup buildPartial()
Returns
Type Description
Backup

clear()

public Backup.Builder clear()
Returns
Type Description
Backup.Builder
Overrides

clearCapacityGb()

public Backup.Builder clearCapacityGb()

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

This builder for chaining.

clearCreateTime()

public Backup.Builder clearCreateTime()

Output only. The time when the backup was created.

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

Returns
Type Description
Backup.Builder

clearDescription()

public Backup.Builder clearDescription()

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

string description = 2;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearDownloadBytes()

public Backup.Builder clearDownloadBytes()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Backup.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Backup.Builder
Overrides

clearLabels()

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

clearName()

public Backup.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Backup.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Backup.Builder
Overrides

clearSatisfiesPzs()

public Backup.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

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

Returns
Type Description
Backup.Builder

clearSourceFileShare()

public Backup.Builder clearSourceFileShare()

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

string source_file_share = 9;

Returns
Type Description
Backup.Builder

This builder for chaining.

clearSourceInstance()

public Backup.Builder clearSourceInstance()

The resource name of the source Cloud 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
Backup.Builder

This builder for chaining.

clearSourceInstanceTier()

public Backup.Builder clearSourceInstanceTier()

Output only. The service tier of the source Cloud 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
Backup.Builder

This builder for chaining.

clearState()

public Backup.Builder clearState()

Output only. The backup state.

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

Returns
Type Description
Backup.Builder

This builder for chaining.

clearStorageBytes()

public Backup.Builder clearStorageBytes()

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

This builder for chaining.

clone()

public Backup.Builder clone()
Returns
Type Description
Backup.Builder
Overrides

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

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the backup was created.

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

Returns
Type Description
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getLabels()

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

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,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.

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.

getSatisfiesPzsBuilder()

public BoolValue.Builder getSatisfiesPzsBuilder()

Output only. Reserved for future use.

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

Returns
Type Description
Builder

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

getSourceFileShare()

public String getSourceFileShare()

Name of the file share in the source Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud 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.

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Backup.Builder mergeCreateTime(Timestamp value)

Output only. The time when the backup was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

mergeFrom(Backup other)

public Backup.Builder mergeFrom(Backup other)
Parameter
Name Description
other Backup
Returns
Type Description
Backup.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Backup.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public Backup.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Backup.Builder
Overrides

mergeSatisfiesPzs(BoolValue value)

public Backup.Builder mergeSatisfiesPzs(BoolValue value)

Output only. Reserved for future use.

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

Parameter
Name Description
value BoolValue
Returns
Type Description
Backup.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Backup.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Backup.Builder
Overrides

putAllLabels(Map<String,String> values)

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

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Backup.Builder

putLabels(String key, String value)

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

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

Parameters
Name Description
key String
value String
Returns
Type Description
Backup.Builder

removeLabels(String key)

public Backup.Builder removeLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
Backup.Builder

setCapacityGb(long value)

public Backup.Builder setCapacityGb(long value)

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

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

Parameter
Name Description
value long

The capacityGb to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Backup.Builder setCreateTime(Timestamp value)

Output only. The time when the backup was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Backup.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Backup.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the backup was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Backup.Builder

setDescription(String value)

public Backup.Builder setDescription(String value)

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

string description = 2;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Backup.Builder setDescriptionBytes(ByteString value)

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

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setDownloadBytes(long value)

public Backup.Builder setDownloadBytes(long value)

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

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

Parameter
Name Description
value long

The downloadBytes to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Backup.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Backup.Builder
Overrides

setName(String value)

public Backup.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Backup.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

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

public Backup.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Backup.Builder
Overrides

setSatisfiesPzs(BoolValue value)

public Backup.Builder setSatisfiesPzs(BoolValue value)

Output only. Reserved for future use.

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

Parameter
Name Description
value BoolValue
Returns
Type Description
Backup.Builder

setSatisfiesPzs(BoolValue.Builder builderForValue)

public Backup.Builder setSatisfiesPzs(BoolValue.Builder builderForValue)

Output only. Reserved for future use.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Backup.Builder

setSourceFileShare(String value)

public Backup.Builder setSourceFileShare(String value)

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

string source_file_share = 9;

Parameter
Name Description
value String

The sourceFileShare to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setSourceFileShareBytes(ByteString value)

public Backup.Builder setSourceFileShareBytes(ByteString value)

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

string source_file_share = 9;

Parameter
Name Description
value ByteString

The bytes for sourceFileShare to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setSourceInstance(String value)

public Backup.Builder setSourceInstance(String value)

The resource name of the source Cloud 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) = { ... }

Parameter
Name Description
value String

The sourceInstance to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setSourceInstanceBytes(ByteString value)

public Backup.Builder setSourceInstanceBytes(ByteString value)

The resource name of the source Cloud 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) = { ... }

Parameter
Name Description
value ByteString

The bytes for sourceInstance to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setSourceInstanceTier(Instance.Tier value)

public Backup.Builder setSourceInstanceTier(Instance.Tier value)

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

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

Parameter
Name Description
value Instance.Tier

The sourceInstanceTier to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setSourceInstanceTierValue(int value)

public Backup.Builder setSourceInstanceTierValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for sourceInstanceTier to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setState(Backup.State value)

public Backup.Builder setState(Backup.State value)

Output only. The backup state.

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

Parameter
Name Description
value Backup.State

The state to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setStateValue(int value)

public Backup.Builder setStateValue(int value)

Output only. The backup state.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setStorageBytes(long value)

public Backup.Builder setStorageBytes(long value)

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

Parameter
Name Description
value long

The storageBytes to set.
Returns
Type Description
Backup.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Backup.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Backup.Builder
Overrides