Class ListBackupsResponse (3.21.3)

public final class ListBackupsResponse extends GeneratedMessageV3 implements ListBackupsResponseOrBuilder

The response for FirestoreAdmin.ListBackups.

Protobuf type google.firestore.admin.v1.ListBackupsResponse

Static Fields

BACKUPS_FIELD_NUMBER

public static final int BACKUPS_FIELD_NUMBER
Field Value
Type Description
int

UNREACHABLE_FIELD_NUMBER

public static final int UNREACHABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListBackupsResponse getDefaultInstance()
Returns
Type Description
ListBackupsResponse

getDescriptor()

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

newBuilder()

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

newBuilder(ListBackupsResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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