public final class ExportDocumentsRequest extends GeneratedMessageV3 implements ExportDocumentsRequestOrBuilderThe request for FirestoreAdmin.ExportDocuments.
Protobuf type google.firestore.admin.v1.ExportDocumentsRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExportDocumentsRequestImplements
ExportDocumentsRequestOrBuilderStatic Fields
COLLECTION_IDS_FIELD_NUMBER
public static final int COLLECTION_IDS_FIELD_NUMBER| Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Type | Description |
int |
OUTPUT_URI_PREFIX_FIELD_NUMBER
public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER| Type | Description |
int |
Static Methods
getDefaultInstance()
public static ExportDocumentsRequest getDefaultInstance()| Type | Description |
ExportDocumentsRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
newBuilder()
public static ExportDocumentsRequest.Builder newBuilder()| Type | Description |
ExportDocumentsRequest.Builder |
newBuilder(ExportDocumentsRequest prototype)
public static ExportDocumentsRequest.Builder newBuilder(ExportDocumentsRequest prototype)| Name | Description |
prototype | ExportDocumentsRequest |
| Type | Description |
ExportDocumentsRequest.Builder |
parseDelimitedFrom(InputStream input)
public static ExportDocumentsRequest parseDelimitedFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
IOException |
parseFrom(byte[] data)
public static ExportDocumentsRequest parseFrom(byte[] data)| Name | Description |
data | byte[] |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ExportDocumentsRequest parseFrom(ByteString data)| Name | Description |
data | ByteString |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ExportDocumentsRequest parseFrom(CodedInputStream input)| Name | Description |
input | CodedInputStream |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
IOException |
parseFrom(InputStream input)
public static ExportDocumentsRequest parseFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static ExportDocumentsRequest parseFrom(ByteBuffer data)| Name | Description |
data | ByteBuffer |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
ExportDocumentsRequest |
| Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<ExportDocumentsRequest> parser()| Type | Description |
Parser<ExportDocumentsRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
obj | Object |
| Type | Description |
boolean |
getCollectionIds(int index)
public String getCollectionIds(int index)Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Name | Description |
index | intThe index of the element to return. |
| Type | Description |
String | The collectionIds at the given index. |
getCollectionIdsBytes(int index)
public ByteString getCollectionIdsBytes(int index)Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Name | Description |
index | intThe index of the value to return. |
| Type | Description |
ByteString | The bytes of the collectionIds at the given index. |
getCollectionIdsCount()
public int getCollectionIdsCount()Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Type | Description |
int | The count of collectionIds. |
getCollectionIdsList()
public ProtocolStringList getCollectionIdsList()Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Type | Description |
ProtocolStringList | A list containing the collectionIds. |
getDefaultInstanceForType()
public ExportDocumentsRequest getDefaultInstanceForType()| Type | Description |
ExportDocumentsRequest |
getName()
public String getName() Required. Database to export. Should be of the form:
projects/{project_id}/databases/{database_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes() Required. Database to export. Should be of the form:
projects/{project_id}/databases/{database_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
ByteString | The bytes for name. |
getOutputUriPrefix()
public String getOutputUriPrefix() The output URI. Currently only supports Google Cloud Storage URIs of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name
of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional
Google Cloud Storage namespace path. When
choosing a name, be sure to consider Google Cloud Storage naming
guidelines: https://cloud.google.com/storage/docs/naming.
If the URI is a bucket (without a namespace path), a prefix will be
generated based on the start time.
string output_uri_prefix = 3;
| Type | Description |
String | The outputUriPrefix. |
getOutputUriPrefixBytes()
public ByteString getOutputUriPrefixBytes() The output URI. Currently only supports Google Cloud Storage URIs of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name
of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional
Google Cloud Storage namespace path. When
choosing a name, be sure to consider Google Cloud Storage naming
guidelines: https://cloud.google.com/storage/docs/naming.
If the URI is a bucket (without a namespace path), a prefix will be
generated based on the start time.
string output_uri_prefix = 3;
| Type | Description |
ByteString | The bytes for outputUriPrefix. |
getParserForType()
public Parser<ExportDocumentsRequest> getParserForType()| Type | Description |
Parser<ExportDocumentsRequest> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
newBuilderForType()
public ExportDocumentsRequest.Builder newBuilderForType()| Type | Description |
ExportDocumentsRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExportDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
parent | BuilderParent |
| Type | Description |
ExportDocumentsRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
unused | UnusedPrivateParameter |
| Type | Description |
Object |
toBuilder()
public ExportDocumentsRequest.Builder toBuilder()| Type | Description |
ExportDocumentsRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
output | CodedOutputStream |
| Type | Description |
IOException |