Class ExportEntitiesRequest.Builder (2.24.3)

Version 2.24.3

• 2.25.1 (latest)
• 2.24.3
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportEntitiesRequest.Builder

Implements

ExportEntitiesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ExportEntitiesRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ExportEntitiesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ExportEntitiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
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	ByteString The 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	String The 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	ByteString The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ExportEntitiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)