Package com.google.firestore.admin.v1

Class ExportDocumentsMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.ExportDocumentsMetadata
All Implemented Interfaces:
ExportDocumentsMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ExportDocumentsMetadata extends com.google.protobuf.GeneratedMessage implements ExportDocumentsMetadataOrBuilder
 Metadata for [google.longrunning.Operation][google.longrunning.Operation]
 results from
 [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
Protobuf type google.firestore.admin.v1.ExportDocumentsMetadata
See Also:

  • Field Details

    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:

    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:

    • OPERATION_STATE_FIELD_NUMBER

      public static final int OPERATION_STATE_FIELD_NUMBER
      See Also:

    • PROGRESS_DOCUMENTS_FIELD_NUMBER

      public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER
      See Also:

    • PROGRESS_BYTES_FIELD_NUMBER

      public static final int PROGRESS_BYTES_FIELD_NUMBER
      See Also:

    • COLLECTION_IDS_FIELD_NUMBER

      public static final int COLLECTION_IDS_FIELD_NUMBER
      See Also:

    • OUTPUT_URI_PREFIX_FIELD_NUMBER

      public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER
      See Also:

    • NAMESPACE_IDS_FIELD_NUMBER

      public static final int NAMESPACE_IDS_FIELD_NUMBER
      See Also:

    • SNAPSHOT_TIME_FIELD_NUMBER

      public static final int SNAPSHOT_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasStartTime

      public boolean hasStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Specified by:
      hasStartTime in interface ExportDocumentsMetadataOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Specified by:
      getStartTime in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Specified by:
      getStartTimeOrBuilder in interface ExportDocumentsMetadataOrBuilder

    • hasEndTime

      public boolean hasEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Specified by:
      hasEndTime in interface ExportDocumentsMetadataOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public com.google.protobuf.Timestamp getEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Specified by:
      getEndTime in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Specified by:
      getEndTimeOrBuilder in interface ExportDocumentsMetadataOrBuilder

    • getOperationStateValue

      public int getOperationStateValue()
       The state of the export operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Specified by:
      getOperationStateValue in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The enum numeric value on the wire for operationState.

    • getOperationState

      public OperationState getOperationState()
       The state of the export operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Specified by:
      getOperationState in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The operationState.

    • hasProgressDocuments

      public boolean hasProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;
      Specified by:
      hasProgressDocuments in interface ExportDocumentsMetadataOrBuilder
      Returns:
      Whether the progressDocuments field is set.

    • getProgressDocuments

      public Progress getProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;
      Specified by:
      getProgressDocuments in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The progressDocuments.

    • getProgressDocumentsOrBuilder

      public ProgressOrBuilder getProgressDocumentsOrBuilder()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;
      Specified by:
      getProgressDocumentsOrBuilder in interface ExportDocumentsMetadataOrBuilder

    • hasProgressBytes

      public boolean hasProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;
      Specified by:
      hasProgressBytes in interface ExportDocumentsMetadataOrBuilder
      Returns:
      Whether the progressBytes field is set.

    • getProgressBytes

      public Progress getProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;
      Specified by:
      getProgressBytes in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The progressBytes.

    • getProgressBytesOrBuilder

      public ProgressOrBuilder getProgressBytesOrBuilder()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;
      Specified by:
      getProgressBytesOrBuilder in interface ExportDocumentsMetadataOrBuilder

    • getCollectionIdsList

      public com.google.protobuf.ProtocolStringList getCollectionIdsList()
       Which collection IDs are being exported.
      repeated string collection_ids = 6;
      Specified by:
      getCollectionIdsList in interface ExportDocumentsMetadataOrBuilder
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      public int getCollectionIdsCount()
       Which collection IDs are being exported.
      repeated string collection_ids = 6;
      Specified by:
      getCollectionIdsCount in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The count of collectionIds.

    • getCollectionIds

      public String getCollectionIds(int index)
       Which collection IDs are being exported.
      repeated string collection_ids = 6;
      Specified by:
      getCollectionIds in interface ExportDocumentsMetadataOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The collectionIds at the given index.

    • getCollectionIdsBytes

      public com.google.protobuf.ByteString getCollectionIdsBytes(int index)
       Which collection IDs are being exported.
      repeated string collection_ids = 6;
      Specified by:
      getCollectionIdsBytes in interface ExportDocumentsMetadataOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • getOutputUriPrefix

      public String getOutputUriPrefix()
       Where the documents are being exported to.
      string output_uri_prefix = 7;
      Specified by:
      getOutputUriPrefix in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The outputUriPrefix.

    • getOutputUriPrefixBytes

      public com.google.protobuf.ByteString getOutputUriPrefixBytes()
       Where the documents are being exported to.
      string output_uri_prefix = 7;
      Specified by:
      getOutputUriPrefixBytes in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The bytes for outputUriPrefix.

    • getNamespaceIdsList

      public com.google.protobuf.ProtocolStringList getNamespaceIdsList()
       Which namespace IDs are being exported.
      repeated string namespace_ids = 8;
      Specified by:
      getNamespaceIdsList in interface ExportDocumentsMetadataOrBuilder
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      public int getNamespaceIdsCount()
       Which namespace IDs are being exported.
      repeated string namespace_ids = 8;
      Specified by:
      getNamespaceIdsCount in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      public String getNamespaceIds(int index)
       Which namespace IDs are being exported.
      repeated string namespace_ids = 8;
      Specified by:
      getNamespaceIds in interface ExportDocumentsMetadataOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The namespaceIds at the given index.

    • getNamespaceIdsBytes

      public com.google.protobuf.ByteString getNamespaceIdsBytes(int index)
       Which namespace IDs are being exported.
      repeated string namespace_ids = 8;
      Specified by:
      getNamespaceIdsBytes in interface ExportDocumentsMetadataOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.

    • hasSnapshotTime

      public boolean hasSnapshotTime()
       The timestamp that corresponds to the version of the database that is being
 exported. If unspecified, there are no guarantees about the consistency of
 the documents being exported.
      .google.protobuf.Timestamp snapshot_time = 9;
      Specified by:
      hasSnapshotTime in interface ExportDocumentsMetadataOrBuilder
      Returns:
      Whether the snapshotTime field is set.

    • getSnapshotTime

      public com.google.protobuf.Timestamp getSnapshotTime()
       The timestamp that corresponds to the version of the database that is being
 exported. If unspecified, there are no guarantees about the consistency of
 the documents being exported.
      .google.protobuf.Timestamp snapshot_time = 9;
      Specified by:
      getSnapshotTime in interface ExportDocumentsMetadataOrBuilder
      Returns:
      The snapshotTime.

    • getSnapshotTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getSnapshotTimeOrBuilder()
       The timestamp that corresponds to the version of the database that is being
 exported. If unspecified, there are no guarantees about the consistency of
 the documents being exported.
      .google.protobuf.Timestamp snapshot_time = 9;
      Specified by:
      getSnapshotTimeOrBuilder in interface ExportDocumentsMetadataOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportDocumentsMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportDocumentsMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDocumentsMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExportDocumentsMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExportDocumentsMetadata.Builder newBuilder()

    • newBuilder

      public static ExportDocumentsMetadata.Builder newBuilder(ExportDocumentsMetadata prototype)

    • toBuilder

      public ExportDocumentsMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExportDocumentsMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ExportDocumentsMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExportDocumentsMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExportDocumentsMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ExportDocumentsMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder