Class ImportEntitiesRequest.Builder (2.20.0)

public static final class ImportEntitiesRequest.Builder extends GeneratedMessageV3.Builder<ImportEntitiesRequest.Builder> implements ImportEntitiesRequestOrBuilder

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

Protobuf type google.datastore.admin.v1.ImportEntitiesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

build()

public ImportEntitiesRequest build()
Returns
Type Description
ImportEntitiesRequest

buildPartial()

public ImportEntitiesRequest buildPartial()
Returns
Type Description
ImportEntitiesRequest

clear()

public ImportEntitiesRequest.Builder clear()
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

clearEntityFilter()

public ImportEntitiesRequest.Builder clearEntityFilter()

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

.google.datastore.admin.v1.EntityFilter entity_filter = 4;

Returns
Type Description
ImportEntitiesRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ImportEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

clearInputUrl()

public ImportEntitiesRequest.Builder clearInputUrl()

Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

string input_url = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ImportEntitiesRequest.Builder

This builder for chaining.

clearLabels()

public ImportEntitiesRequest.Builder clearLabels()
Returns
Type Description
ImportEntitiesRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

clearProjectId()

public ImportEntitiesRequest.Builder clearProjectId()

Required. Project ID against which to make the request.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ImportEntitiesRequest.Builder

This builder for chaining.

clone()

public ImportEntitiesRequest.Builder clone()
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

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 ImportEntitiesRequest getDefaultInstanceForType()
Returns
Type Description
ImportEntitiesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEntityFilter()

public EntityFilter getEntityFilter()

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

.google.datastore.admin.v1.EntityFilter entity_filter = 4;

Returns
Type Description
EntityFilter

The entityFilter.

getEntityFilterBuilder()

public EntityFilter.Builder getEntityFilterBuilder()

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

.google.datastore.admin.v1.EntityFilter entity_filter = 4;

Returns
Type Description
EntityFilter.Builder

getEntityFilterOrBuilder()

public EntityFilterOrBuilder getEntityFilterOrBuilder()

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

.google.datastore.admin.v1.EntityFilter entity_filter = 4;

Returns
Type Description
EntityFilterOrBuilder

getInputUrl()

public String getInputUrl()

Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

string input_url = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The inputUrl.

getInputUrlBytes()

public ByteString getInputUrlBytes()

Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

string input_url = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for inputUrl.

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>

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

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

.google.datastore.admin.v1.EntityFilter entity_filter = 4;

Returns
Type Description
boolean

Whether the entityFilter field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

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

mergeEntityFilter(EntityFilter value)

public ImportEntitiesRequest.Builder mergeEntityFilter(EntityFilter value)

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

.google.datastore.admin.v1.EntityFilter entity_filter = 4;

Parameter
Name Description
value EntityFilter
Returns
Type Description
ImportEntitiesRequest.Builder

mergeFrom(ImportEntitiesRequest other)

public ImportEntitiesRequest.Builder mergeFrom(ImportEntitiesRequest other)
Parameter
Name Description
other ImportEntitiesRequest
Returns
Type Description
ImportEntitiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImportEntitiesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

putAllLabels(Map<String,String> values)

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

Client-assigned labels.

map<string, string> labels = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ImportEntitiesRequest.Builder

putLabels(String key, String value)

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

Client-assigned labels.

map<string, string> labels = 2;

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

removeLabels(String key)

public ImportEntitiesRequest.Builder removeLabels(String key)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
ImportEntitiesRequest.Builder

setEntityFilter(EntityFilter value)

public ImportEntitiesRequest.Builder setEntityFilter(EntityFilter value)

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

.google.datastore.admin.v1.EntityFilter entity_filter = 4;

Parameter
Name Description
value EntityFilter
Returns
Type Description
ImportEntitiesRequest.Builder

setEntityFilter(EntityFilter.Builder builderForValue)

public ImportEntitiesRequest.Builder setEntityFilter(EntityFilter.Builder builderForValue)

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

.google.datastore.admin.v1.EntityFilter entity_filter = 4;

Parameter
Name Description
builderForValue EntityFilter.Builder
Returns
Type Description
ImportEntitiesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ImportEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

setInputUrl(String value)

public ImportEntitiesRequest.Builder setInputUrl(String value)

Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

string input_url = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The inputUrl to set.

Returns
Type Description
ImportEntitiesRequest.Builder

This builder for chaining.

setInputUrlBytes(ByteString value)

public ImportEntitiesRequest.Builder setInputUrlBytes(ByteString value)

Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

string input_url = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for inputUrl to set.

Returns
Type Description
ImportEntitiesRequest.Builder

This builder for chaining.

setProjectId(String value)

public ImportEntitiesRequest.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
ImportEntitiesRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public ImportEntitiesRequest.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
ImportEntitiesRequest.Builder

This builder for chaining.

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

public ImportEntitiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportEntitiesRequest.Builder
Overrides