public static final class ExportEntitiesRequest.Builder extends GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder> implements ExportEntitiesRequestOrBuilder
The request for
google.datastore.admin.v1.DatastoreAdmin.ExportEntities.
Protobuf type google.datastore.admin.v1.ExportEntitiesRequest
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExportEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public ExportEntitiesRequest build()
Returns
buildPartial()
public ExportEntitiesRequest buildPartial()
Returns
clear()
public ExportEntitiesRequest.Builder clear()
Returns
Overrides
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;
Returns
clearField(Descriptors.FieldDescriptor field)
public ExportEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearLabels()
public ExportEntitiesRequest.Builder clearLabels()
Returns
clearOneof(Descriptors.OneofDescriptor oneof)
public ExportEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
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.
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
clearProjectId()
public ExportEntitiesRequest.Builder clearProjectId()
Required. Project ID against which to make the request.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
clone()
public ExportEntitiesRequest.Builder clone()
Returns
Overrides
containsLabels(String key)
public boolean containsLabels(String key)
Client-assigned labels.
map<string, string> labels = 2;
Parameter
Returns
getDefaultInstanceForType()
public ExportEntitiesRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getEntityFilter()
public EntityFilter getEntityFilter()
Description of what data from the project is included in the export.
.google.datastore.admin.v1.EntityFilter entity_filter = 3;
Returns
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;
Returns
getEntityFilterOrBuilder()
public EntityFilterOrBuilder getEntityFilterOrBuilder()
Description of what data from the project is included in the export.
.google.datastore.admin.v1.EntityFilter entity_filter = 3;
Returns
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Client-assigned labels.
map<string, string> labels = 2;
Returns
getLabelsMap()
public Map<String,String> getLabelsMap()
Client-assigned labels.
map<string, string> labels = 2;
Returns
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Client-assigned labels.
map<string, string> labels = 2;
Parameters
Returns
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Client-assigned labels.
map<string, string> labels = 2;
Parameter
Returns
getMutableLabels()
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns
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.
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 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 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 ByteString getProjectIdBytes()
Required. Project ID against which to make the request.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
hasEntityFilter()
public 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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeEntityFilter(EntityFilter value)
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;
Parameter
Returns
mergeFrom(ExportEntitiesRequest other)
public ExportEntitiesRequest.Builder mergeFrom(ExportEntitiesRequest other)
Parameter
Returns
public ExportEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public ExportEntitiesRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExportEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
putAllLabels(Map<String,String> values)
public ExportEntitiesRequest.Builder putAllLabels(Map<String,String> values)
Client-assigned labels.
map<string, string> labels = 2;
Parameter
Returns
putLabels(String key, String value)
public ExportEntitiesRequest.Builder putLabels(String key, String value)
Client-assigned labels.
map<string, string> labels = 2;
Parameters
Returns
removeLabels(String key)
public ExportEntitiesRequest.Builder removeLabels(String key)
Client-assigned labels.
map<string, string> labels = 2;
Parameter
Returns
setEntityFilter(EntityFilter value)
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;
Parameter
Returns
setEntityFilter(EntityFilter.Builder builderForValue)
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;
Parameter
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public ExportEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setOutputUrlPrefix(String value)
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.
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];
Parameter
Name | Description |
value | String
The outputUrlPrefix to set.
|
Returns
setOutputUrlPrefixBytes(ByteString value)
public ExportEntitiesRequest.Builder setOutputUrlPrefixBytes(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.
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];
Parameter
Name | Description |
value | ByteString
The bytes for outputUrlPrefix to set.
|
Returns
setProjectId(String value)
public ExportEntitiesRequest.Builder setProjectId(String value)
Required. Project ID against which to make the request.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name | Description |
value | String
The projectId to set.
|
Returns
setProjectIdBytes(ByteString value)
public ExportEntitiesRequest.Builder setProjectIdBytes(ByteString value)
Required. Project ID against which to make the request.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name | Description |
value | ByteString
The bytes for projectId to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExportEntitiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ExportEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides