Class ExportEntitiesRequest.Builder (2.23.0) 

publicstaticfinalclass ExportEntitiesRequest.BuilderextendsGeneratedMessageV3.Builder<ExportEntitiesRequest.Builder>implementsExportEntitiesRequestOrBuilder

The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.

Protobuf type google.datastore.admin.v1.ExportEntitiesRequest

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicExportEntitiesRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

build()

publicExportEntitiesRequestbuild()
Returns
Type Description
ExportEntitiesRequest

buildPartial()

publicExportEntitiesRequestbuildPartial()
Returns
Type Description
ExportEntitiesRequest

clear()

publicExportEntitiesRequest.Builderclear()
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

clearEntityFilter()

publicExportEntitiesRequest.BuilderclearEntityFilter()

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)

publicExportEntitiesRequest.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

clearLabels()

publicExportEntitiesRequest.BuilderclearLabels()
Returns
Type Description
ExportEntitiesRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

publicExportEntitiesRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

clearOutputUrlPrefix()

publicExportEntitiesRequest.BuilderclearOutputUrlPrefix()

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()

publicExportEntitiesRequest.BuilderclearProjectId()

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()

publicExportEntitiesRequest.Builderclone()
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

containsLabels(String key)

publicbooleancontainsLabels(Stringkey)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

publicExportEntitiesRequestgetDefaultInstanceForType()
Returns
Type Description
ExportEntitiesRequest

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEntityFilter()

publicEntityFiltergetEntityFilter()

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()

publicEntityFilter.BuildergetEntityFilterBuilder()

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()

publicEntityFilterOrBuildergetEntityFilterOrBuilder()

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)

publicMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

publicintgetLabelsCount()

Client-assigned labels.

map<string, string> labels = 2;

Returns
Type Description
int

getLabelsMap()

publicMap<String,String>getLabelsMap()

Client-assigned labels.

map<string, string> labels = 2;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

Client-assigned labels.

map<string, string> labels = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

publicStringgetLabelsOrThrow(Stringkey)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

publicMap<String,String>getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getOutputUrlPrefix()

publicStringgetOutputUrlPrefix()

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()

publicByteStringgetOutputUrlPrefixBytes()

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()

publicStringgetProjectId()

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()

publicByteStringgetProjectIdBytes()

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()

publicbooleanhasEntityFilter()

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()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMutableMapFieldReflection(intnumber)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeEntityFilter(EntityFilter value)

publicExportEntitiesRequest.BuildermergeEntityFilter(EntityFiltervalue)

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)

publicExportEntitiesRequest.BuildermergeFrom(ExportEntitiesRequestother)
Parameter
Name Description
other ExportEntitiesRequest
Returns
Type Description
ExportEntitiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicExportEntitiesRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicExportEntitiesRequest.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalExportEntitiesRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

putAllLabels(Map<String,String> values)

publicExportEntitiesRequest.BuilderputAllLabels(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)

publicExportEntitiesRequest.BuilderputLabels(Stringkey,Stringvalue)

Client-assigned labels.

map<string, string> labels = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
ExportEntitiesRequest.Builder

removeLabels(String key)

publicExportEntitiesRequest.BuilderremoveLabels(Stringkey)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
ExportEntitiesRequest.Builder

setEntityFilter(EntityFilter value)

publicExportEntitiesRequest.BuildersetEntityFilter(EntityFiltervalue)

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)

publicExportEntitiesRequest.BuildersetEntityFilter(EntityFilter.BuilderbuilderForValue)

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)

publicExportEntitiesRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

setOutputUrlPrefix(String value)

publicExportEntitiesRequest.BuildersetOutputUrlPrefix(Stringvalue)

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
Type Description
ExportEntitiesRequest.Builder

This builder for chaining.

setOutputUrlPrefixBytes(ByteString value)

publicExportEntitiesRequest.BuildersetOutputUrlPrefixBytes(ByteStringvalue)

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
Type Description
ExportEntitiesRequest.Builder

This builder for chaining.

setProjectId(String value)

publicExportEntitiesRequest.BuildersetProjectId(Stringvalue)

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
Type Description
ExportEntitiesRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

publicExportEntitiesRequest.BuildersetProjectIdBytes(ByteStringvalue)

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
Type Description
ExportEntitiesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicExportEntitiesRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalExportEntitiesRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportEntitiesRequest.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.