Class ListBackupsResponse.Builder (3.26.5)

public static final class ListBackupsResponse.Builder extends GeneratedMessageV3.Builder<ListBackupsResponse.Builder> implements ListBackupsResponseOrBuilder

The response for FirestoreAdmin.ListBackups.

Protobuf type google.firestore.admin.v1.ListBackupsResponse

Static Methods

getDescriptor()

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

Methods

addAllBackups(Iterable<? extends Backup> values)

public ListBackupsResponse.Builder addAllBackups(Iterable<? extends Backup> values)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameter
Name Description
values Iterable<? extends com.google.firestore.admin.v1.Backup>
Returns
Type Description
ListBackupsResponse.Builder

addAllUnreachable(Iterable<String> values)

public ListBackupsResponse.Builder addAllUnreachable(Iterable<String> values)

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Parameter
Name Description
values Iterable<String>

The unreachable to add.

Returns
Type Description
ListBackupsResponse.Builder

This builder for chaining.

addBackups(Backup value)

public ListBackupsResponse.Builder addBackups(Backup value)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameter
Name Description
value Backup
Returns
Type Description
ListBackupsResponse.Builder

addBackups(Backup.Builder builderForValue)

public ListBackupsResponse.Builder addBackups(Backup.Builder builderForValue)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameter
Name Description
builderForValue Backup.Builder
Returns
Type Description
ListBackupsResponse.Builder

addBackups(int index, Backup value)

public ListBackupsResponse.Builder addBackups(int index, Backup value)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameters
Name Description
index int
value Backup
Returns
Type Description
ListBackupsResponse.Builder

addBackups(int index, Backup.Builder builderForValue)

public ListBackupsResponse.Builder addBackups(int index, Backup.Builder builderForValue)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameters
Name Description
index int
builderForValue Backup.Builder
Returns
Type Description
ListBackupsResponse.Builder

addBackupsBuilder()

public Backup.Builder addBackupsBuilder()

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Returns
Type Description
Backup.Builder

addBackupsBuilder(int index)

public Backup.Builder addBackupsBuilder(int index)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameter
Name Description
index int
Returns
Type Description
Backup.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addUnreachable(String value)

public ListBackupsResponse.Builder addUnreachable(String value)

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Parameter
Name Description
value String

The unreachable to add.

Returns
Type Description
ListBackupsResponse.Builder

This builder for chaining.

addUnreachableBytes(ByteString value)

public ListBackupsResponse.Builder addUnreachableBytes(ByteString value)

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Parameter
Name Description
value ByteString

The bytes of the unreachable to add.

Returns
Type Description
ListBackupsResponse.Builder

This builder for chaining.

build()

public ListBackupsResponse build()
Returns
Type Description
ListBackupsResponse

buildPartial()

public ListBackupsResponse buildPartial()
Returns
Type Description
ListBackupsResponse

clear()

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

clearBackups()

public ListBackupsResponse.Builder clearBackups()

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Returns
Type Description
ListBackupsResponse.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUnreachable()

public ListBackupsResponse.Builder clearUnreachable()

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Returns
Type Description
ListBackupsResponse.Builder

This builder for chaining.

clone()

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

getBackups(int index)

public Backup getBackups(int index)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameter
Name Description
index int
Returns
Type Description
Backup

getBackupsBuilder(int index)

public Backup.Builder getBackupsBuilder(int index)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameter
Name Description
index int
Returns
Type Description
Backup.Builder

getBackupsBuilderList()

public List<Backup.Builder> getBackupsBuilderList()

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Returns
Type Description
List<Builder>

getBackupsCount()

public int getBackupsCount()

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Returns
Type Description
int

getBackupsList()

public List<Backup> getBackupsList()

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Returns
Type Description
List<Backup>

getBackupsOrBuilder(int index)

public BackupOrBuilder getBackupsOrBuilder(int index)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameter
Name Description
index int
Returns
Type Description
BackupOrBuilder

getBackupsOrBuilderList()

public List<? extends BackupOrBuilder> getBackupsOrBuilderList()

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Returns
Type Description
List<? extends com.google.firestore.admin.v1.BackupOrBuilder>

getDefaultInstanceForType()

public ListBackupsResponse getDefaultInstanceForType()
Returns
Type Description
ListBackupsResponse

getDescriptorForType()

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

getUnreachable(int index)

public String getUnreachable(int index)

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The unreachable at the given index.

getUnreachableBytes(int index)

public ByteString getUnreachableBytes(int index)

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the unreachable at the given index.

getUnreachableCount()

public int getUnreachableCount()

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Returns
Type Description
int

The count of unreachable.

getUnreachableList()

public ProtocolStringList getUnreachableList()

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Returns
Type Description
ProtocolStringList

A list containing the unreachable.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListBackupsResponse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeBackups(int index)

public ListBackupsResponse.Builder removeBackups(int index)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameter
Name Description
index int
Returns
Type Description
ListBackupsResponse.Builder

setBackups(int index, Backup value)

public ListBackupsResponse.Builder setBackups(int index, Backup value)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameters
Name Description
index int
value Backup
Returns
Type Description
ListBackupsResponse.Builder

setBackups(int index, Backup.Builder builderForValue)

public ListBackupsResponse.Builder setBackups(int index, Backup.Builder builderForValue)

List of all backups for the project.

repeated .google.firestore.admin.v1.Backup backups = 1;

Parameters
Name Description
index int
builderForValue Backup.Builder
Returns
Type Description
ListBackupsResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUnreachable(int index, String value)

public ListBackupsResponse.Builder setUnreachable(int index, String value)

List of locations that existing backups were not able to be fetched from.

Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.

repeated string unreachable = 3;

Parameters
Name Description
index int

The index to set the value at.

value String

The unreachable to set.

Returns
Type Description
ListBackupsResponse.Builder

This builder for chaining.