Class ExportEntitiesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
com.google.datastore.admin.v1.ExportEntitiesRequest.Builder
All Implemented Interfaces:
ExportEntitiesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ExportEntitiesRequest

public static final class ExportEntitiesRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder> implements ExportEntitiesRequestOrBuilder
 The request for
 [google.datastore.admin.v1.DatastoreAdmin.ExportEntities][google.datastore.admin.v1.DatastoreAdmin.ExportEntities].
 
Protobuf type google.datastore.admin.v1.ExportEntitiesRequest
  • Method Details

    • 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.Builder<ExportEntitiesRequest.Builder>
    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • getDefaultInstanceForType

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

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

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

      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • setField

      public ExportEntitiesRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • clearField

      public ExportEntitiesRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • clearOneof

      public ExportEntitiesRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • setRepeatedField

      public ExportEntitiesRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • addRepeatedField

      public ExportEntitiesRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • mergeFrom

      public ExportEntitiesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportEntitiesRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • mergeFrom

      public ExportEntitiesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportEntitiesRequest.Builder>
      Throws:
      IOException
    • 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.
    • setProjectId

      public ExportEntitiesRequest.Builder setProjectId(String value)
       Required. Project ID against which to make the request.
       
      string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The projectId to set.
      Returns:
      This builder for chaining.
    • clearProjectId

      public ExportEntitiesRequest.Builder clearProjectId()
       Required. Project ID against which to make the request.
       
      string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • setProjectIdBytes

      public ExportEntitiesRequest.Builder setProjectIdBytes(com.google.protobuf.ByteString value)
       Required. Project ID against which to make the request.
       
      string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for projectId to set.
      Returns:
      This builder for chaining.
    • 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
    • clearLabels

      public ExportEntitiesRequest.Builder clearLabels()
    • removeLabels

      public ExportEntitiesRequest.Builder removeLabels(String key)
       Client-assigned labels.
       
      map<string, string> labels = 2;
    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.
    • putLabels

      public ExportEntitiesRequest.Builder putLabels(String key, String value)
       Client-assigned labels.
       
      map<string, string> labels = 2;
    • putAllLabels

      public ExportEntitiesRequest.Builder putAllLabels(Map<String,String> values)
       Client-assigned labels.
       
      map<string, string> labels = 2;
    • 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.
    • setEntityFilter

      public ExportEntitiesRequest.Builder setEntityFilter(EntityFilter value)
       Description of what data from the project is included in the export.
       
      .google.datastore.admin.v1.EntityFilter entity_filter = 3;
    • setEntityFilter

      public ExportEntitiesRequest.Builder setEntityFilter(EntityFilter.Builder builderForValue)
       Description of what data from the project is included in the export.
       
      .google.datastore.admin.v1.EntityFilter entity_filter = 3;
    • mergeEntityFilter

      public ExportEntitiesRequest.Builder mergeEntityFilter(EntityFilter value)
       Description of what data from the project is included in the export.
       
      .google.datastore.admin.v1.EntityFilter entity_filter = 3;
    • clearEntityFilter

      public ExportEntitiesRequest.Builder clearEntityFilter()
       Description of what data from the project is included in the export.
       
      .google.datastore.admin.v1.EntityFilter entity_filter = 3;
    • getEntityFilterBuilder

      public EntityFilter.Builder getEntityFilterBuilder()
       Description of what data from the project is included in the export.
       
      .google.datastore.admin.v1.EntityFilter entity_filter = 3;
    • 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.
    • setOutputUrlPrefix

      public ExportEntitiesRequest.Builder setOutputUrlPrefix(String value)
       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];
      Parameters:
      value - The outputUrlPrefix to set.
      Returns:
      This builder for chaining.
    • clearOutputUrlPrefix

      public ExportEntitiesRequest.Builder clearOutputUrlPrefix()
       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];
      Returns:
      This builder for chaining.
    • setOutputUrlPrefixBytes

      public ExportEntitiesRequest.Builder setOutputUrlPrefixBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for outputUrlPrefix to set.
      Returns:
      This builder for chaining.
    • setUnknownFields

      public final ExportEntitiesRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>
    • mergeUnknownFields

      public final ExportEntitiesRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>