Package com.google.datastore.admin.v1

Interface ExportEntitiesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ExportEntitiesRequest, ExportEntitiesRequest.Builder
    public interface ExportEntitiesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getProjectId

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

      • getProjectIdBytes

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

      • getLabelsCount

        int getLabelsCount()
         Client-assigned labels.
        map<string, string> labels = 2;

      • containsLabels

        boolean containsLabels​(String key)
         Client-assigned labels.
        map<string, string> labels = 2;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Client-assigned labels.
        map<string, string> labels = 2;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Client-assigned labels.
        map<string, string> labels = 2;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Client-assigned labels.
        map<string, string> labels = 2;

      • hasEntityFilter

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

      • getEntityFilter

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

      • getEntityFilterOrBuilder

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

      • getOutputUrlPrefix

        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];
        Returns:
        The outputUrlPrefix.

      • getOutputUrlPrefixBytes

        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];
        Returns:
        The bytes for outputUrlPrefix.