public static final class ExportEntitiesRequest.Builder extends GeneratedMessageV3.Builder<ExportEntitiesRequest.Builder> implements ExportEntitiesRequestOrBuilderThe request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.
Protobuf type google.datastore.admin.v1.ExportEntitiesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportEntitiesRequest.BuilderImplements
ExportEntitiesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExportEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
build()
public ExportEntitiesRequest build()| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest |
|
buildPartial()
public ExportEntitiesRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest |
|
clear()
public ExportEntitiesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
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 | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ExportEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
clearLabels()
public ExportEntitiesRequest.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ExportEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
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 | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
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 | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
This builder for chaining. |
clone()
public ExportEntitiesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
containsLabels(String key)
public boolean containsLabels(String key)Client-assigned labels.
map<string, string> labels = 2;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public ExportEntitiesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
EntityFilter |
The entityFilter. |
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 | |
|---|---|
| Type | Description |
EntityFilter.Builder |
|
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 | |
|---|---|
| Type | Description |
EntityFilterOrBuilder |
|
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public int getLabelsCount()Client-assigned labels.
map<string, string> labels = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()Client-assigned labels.
map<string, string> labels = 2;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public 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 String getLabelsOrThrow(String key)Client-assigned labels.
map<string, string> labels = 2;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for projectId. |
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 | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 | |
|---|---|
| Name | Description |
value |
EntityFilter |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
mergeFrom(ExportEntitiesRequest other)
public ExportEntitiesRequest.Builder mergeFrom(ExportEntitiesRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ExportEntitiesRequest |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExportEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExportEntitiesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExportEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
putAllLabels(Map<String,String> values)
public ExportEntitiesRequest.Builder putAllLabels(Map<String,String> values)Client-assigned labels.
map<string, string> labels = 2;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
putLabels(String key, String value)
public ExportEntitiesRequest.Builder putLabels(String key, String value)Client-assigned labels.
map<string, string> labels = 2;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
removeLabels(String key)
public ExportEntitiesRequest.Builder removeLabels(String key)Client-assigned labels.
map<string, string> labels = 2;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
EntityFilter |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
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 | |
|---|---|
| Name | Description |
builderForValue |
EntityFilter.Builder |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ExportEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
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 |
StringThe outputUrlPrefix to set. |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
This builder for chaining. |
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 |
ByteStringThe bytes for outputUrlPrefix to set. |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
This builder for chaining. |
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 |
StringThe projectId to set. |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
This builder for chaining. |
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 |
ByteStringThe bytes for projectId to set. |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExportEntitiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ExportEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportEntitiesRequest.Builder |
|