Interface ExportEntitiesRequestOrBuilder (2.21.1) 

public interface ExportEntitiesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getEntityFilter()

public abstract EntityFilter getEntityFilter()

Description of what data from the project is included in the export.

.google.datastore.admin.v1.EntityFilter entity_filter = 3;

Returns
Type Description
EntityFilter

The entityFilter.

getEntityFilterOrBuilder()

public abstract EntityFilterOrBuilder getEntityFilterOrBuilder()

Description of what data from the project is included in the export.

.google.datastore.admin.v1.EntityFilter entity_filter = 3;

Returns
Type Description
EntityFilterOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Client-assigned labels.

map<string, string> labels = 2;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Client-assigned labels.

map<string, string> labels = 2;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Client-assigned labels.

map<string, string> labels = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getOutputUrlPrefix()

public abstract 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.

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 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
Type Description
String

The outputUrlPrefix.

getOutputUrlPrefixBytes()

public abstract 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.

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 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
Type Description
ByteString

The bytes for outputUrlPrefix.

getProjectId()

public abstract String getProjectId()

Required. Project ID against which to make the request.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

Required. Project ID against which to make the request.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

hasEntityFilter()

public abstract boolean hasEntityFilter()

Description of what data from the project is included in the export.

.google.datastore.admin.v1.EntityFilter entity_filter = 3;

Returns
Type Description
boolean

Whether the entityFilter field is set.