Class ExportEntitiesRequest.Builder (2.9.0)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportEntitiesRequest.Builder
Overrides

build()

public ExportEntitiesRequest build()
Returns
TypeDescription
ExportEntitiesRequest

buildPartial()

public ExportEntitiesRequest buildPartial()
Returns
TypeDescription
ExportEntitiesRequest

clear()

public ExportEntitiesRequest.Builder clear()
Returns
TypeDescription
ExportEntitiesRequest.Builder
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
TypeDescription
ExportEntitiesRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ExportEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExportEntitiesRequest.Builder
Overrides

clearLabels()

public ExportEntitiesRequest.Builder clearLabels()
Returns
TypeDescription
ExportEntitiesRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExportEntitiesRequest.Builder
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
TypeDescription
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
TypeDescription
ExportEntitiesRequest.Builder

This builder for chaining.

clone()

public ExportEntitiesRequest.Builder clone()
Returns
TypeDescription
ExportEntitiesRequest.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public ExportEntitiesRequest getDefaultInstanceForType()
Returns
TypeDescription
ExportEntitiesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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
TypeDescription
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
TypeDescription
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
TypeDescription
EntityFilterOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Client-assigned labels.

map<string, string> labels = 2;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Client-assigned labels.

map<string, string> labels = 2;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Client-assigned labels.

map<string, string> labels = 2;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the entityFilter field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
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
NameDescription
valueEntityFilter
Returns
TypeDescription
ExportEntitiesRequest.Builder

mergeFrom(ExportEntitiesRequest other)

public ExportEntitiesRequest.Builder mergeFrom(ExportEntitiesRequest other)
Parameter
NameDescription
otherExportEntitiesRequest
Returns
TypeDescription
ExportEntitiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportEntitiesRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExportEntitiesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExportEntitiesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportEntitiesRequest.Builder
Overrides

putAllLabels(Map<String,String> values)

public ExportEntitiesRequest.Builder putAllLabels(Map<String,String> values)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
ExportEntitiesRequest.Builder

putLabels(String key, String value)

public ExportEntitiesRequest.Builder putLabels(String key, String value)

Client-assigned labels.

map<string, string> labels = 2;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
ExportEntitiesRequest.Builder

removeLabels(String key)

public ExportEntitiesRequest.Builder removeLabels(String key)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueEntityFilter
Returns
TypeDescription
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
NameDescription
builderForValueEntityFilter.Builder
Returns
TypeDescription
ExportEntitiesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExportEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportEntitiesRequest.Builder
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
NameDescription
valueString

The outputUrlPrefix to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for outputUrlPrefix to set.

Returns
TypeDescription
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
NameDescription
valueString

The projectId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for projectId to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExportEntitiesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportEntitiesRequest.Builder
Overrides