Package com.google.datastore.admin.v1

Class ExportEntitiesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.admin.v1.ExportEntitiesRequest
All Implemented Interfaces:
ExportEntitiesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ExportEntitiesRequest extends com.google.protobuf.GeneratedMessageV3 implements ExportEntitiesRequestOrBuilder
 The request for
 [google.datastore.admin.v1.DatastoreAdmin.ExportEntities][google.datastore.admin.v1.DatastoreAdmin.ExportEntities].
Protobuf type google.datastore.admin.v1.ExportEntitiesRequest
See Also:

  • Field Details

    • PROJECT_ID_FIELD_NUMBER

      public static final int PROJECT_ID_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • ENTITY_FILTER_FIELD_NUMBER

      public static final int ENTITY_FILTER_FIELD_NUMBER
      See Also:

    • OUTPUT_URL_PREFIX_FIELD_NUMBER

      public static final int OUTPUT_URL_PREFIX_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

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

    • getProjectId

      public String getProjectId()
       Required. Project ID against which to make the request.
      string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectId in interface ExportEntitiesRequestOrBuilder
      Returns:
      The projectId.

    • getProjectIdBytes

      public com.google.protobuf.ByteString getProjectIdBytes()
       Required. Project ID against which to make the request.
      string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectIdBytes in interface ExportEntitiesRequestOrBuilder
      Returns:
      The bytes for projectId.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: ExportEntitiesRequestOrBuilder
       Client-assigned labels.
      map<string, string> labels = 2;
      Specified by:
      getLabelsCount in interface ExportEntitiesRequestOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Client-assigned labels.
      map<string, string> labels = 2;
      Specified by:
      containsLabels in interface ExportEntitiesRequestOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface ExportEntitiesRequestOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Client-assigned labels.
      map<string, string> labels = 2;
      Specified by:
      getLabelsMap in interface ExportEntitiesRequestOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Client-assigned labels.
      map<string, string> labels = 2;
      Specified by:
      getLabelsOrDefault in interface ExportEntitiesRequestOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Client-assigned labels.
      map<string, string> labels = 2;
      Specified by:
      getLabelsOrThrow in interface ExportEntitiesRequestOrBuilder

    • hasEntityFilter

      public boolean hasEntityFilter()
       Description of what data from the project is included in the export.
      .google.datastore.admin.v1.EntityFilter entity_filter = 3;
      Specified by:
      hasEntityFilter in interface ExportEntitiesRequestOrBuilder
      Returns:
      Whether the entityFilter field is set.

    • getEntityFilter

      public EntityFilter getEntityFilter()
       Description of what data from the project is included in the export.
      .google.datastore.admin.v1.EntityFilter entity_filter = 3;
      Specified by:
      getEntityFilter in interface ExportEntitiesRequestOrBuilder
      Returns:
      The entityFilter.

    • getEntityFilterOrBuilder

      public EntityFilterOrBuilder getEntityFilterOrBuilder()
       Description of what data from the project is included in the export.
      .google.datastore.admin.v1.EntityFilter entity_filter = 3;
      Specified by:
      getEntityFilterOrBuilder in interface ExportEntitiesRequestOrBuilder

    • getOutputUrlPrefix

      public String getOutputUrlPrefix()
       Required. Location for the export metadata and data files.

 The full resource URL of the external storage location. Currently, only
 Google Cloud Storage is supported. So output_url_prefix should be of the
 form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the
 name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud
 Storage namespace path (this is not a Cloud Datastore namespace). For more
 information about Cloud Storage namespace paths, see
 [Object name
 considerations](https://cloud.google.com/storage/docs/naming#object-considerations).

 The resulting files will be nested deeper than the specified URL prefix.
 The final output URL will be provided in the
 [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url]
 field. That value should be used for subsequent ImportEntities operations.

 By nesting the data files deeper, the same Cloud Storage bucket can be used
 in multiple ExportEntities operations without conflict.
      string output_url_prefix = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputUrlPrefix in interface ExportEntitiesRequestOrBuilder
      Returns:
      The outputUrlPrefix.

    • getOutputUrlPrefixBytes

      public com.google.protobuf.ByteString getOutputUrlPrefixBytes()
       Required. Location for the export metadata and data files.

 The full resource URL of the external storage location. Currently, only
 Google Cloud Storage is supported. So output_url_prefix should be of the
 form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the
 name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud
 Storage namespace path (this is not a Cloud Datastore namespace). For more
 information about Cloud Storage namespace paths, see
 [Object name
 considerations](https://cloud.google.com/storage/docs/naming#object-considerations).

 The resulting files will be nested deeper than the specified URL prefix.
 The final output URL will be provided in the
 [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url]
 field. That value should be used for subsequent ImportEntities operations.

 By nesting the data files deeper, the same Cloud Storage bucket can be used
 in multiple ExportEntities operations without conflict.
      string output_url_prefix = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputUrlPrefixBytes in interface ExportEntitiesRequestOrBuilder
      Returns:
      The bytes for outputUrlPrefix.

    • isInitialized

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

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

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

    • 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 ExportEntitiesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ExportEntitiesRequest.Builder newBuilder()

    • newBuilder

      public static ExportEntitiesRequest.Builder newBuilder(ExportEntitiesRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected ExportEntitiesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ExportEntitiesRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ExportEntitiesRequest> 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.GeneratedMessageV3

    • getDefaultInstanceForType

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