Class ListBackupsResponse (3.20.0)

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
TypeDescription
int

UNREACHABLE_FIELD_NUMBER

public static final int UNREACHABLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListBackupsResponse getDefaultInstance()
Returns
TypeDescription
ListBackupsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ListBackupsResponse.Builder newBuilder()
Returns
TypeDescription
ListBackupsResponse.Builder

newBuilder(ListBackupsResponse prototype)

public static ListBackupsResponse.Builder newBuilder(ListBackupsResponse prototype)
Parameter
NameDescription
prototypeListBackupsResponse
Returns
TypeDescription
ListBackupsResponse.Builder

parseDelimitedFrom(InputStream input)

public static ListBackupsResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListBackupsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListBackupsResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListBackupsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListBackupsResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListBackupsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListBackupsResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListBackupsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListBackupsResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListBackupsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListBackupsResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListBackupsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListBackupsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListBackupsResponse> parser()
Returns
TypeDescription
Parser<ListBackupsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Backup

getBackupsCount()

public int getBackupsCount()

List of all backups for the project.

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

Returns
TypeDescription
int

getBackupsList()

public List<Backup> getBackupsList()

List of all backups for the project.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
BackupOrBuilder

getBackupsOrBuilderList()

public List<? extends BackupOrBuilder> getBackupsOrBuilderList()

List of all backups for the project.

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

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

getDefaultInstanceForType()

public ListBackupsResponse getDefaultInstanceForType()
Returns
TypeDescription
ListBackupsResponse

getParserForType()

public Parser<ListBackupsResponse> getParserForType()
Returns
TypeDescription
Parser<ListBackupsResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the unreachable.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListBackupsResponse.Builder newBuilderForType()
Returns
TypeDescription
ListBackupsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListBackupsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListBackupsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListBackupsResponse.Builder toBuilder()
Returns
TypeDescription
ListBackupsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException