Class ImportEntitiesRequest.Builder (2.17.6)

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ImportEntitiesRequest build()
Returns
TypeDescription
ImportEntitiesRequest

buildPartial()

public ImportEntitiesRequest buildPartial()
Returns
TypeDescription
ImportEntitiesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public ImportEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
ImportEntitiesRequest.Builder

This builder for chaining.

clearLabels()

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

This builder for chaining.

clone()

public ImportEntitiesRequest.Builder clone()
Returns
TypeDescription
ImportEntitiesRequest.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 ImportEntitiesRequest getDefaultInstanceForType()
Returns
TypeDescription
ImportEntitiesRequest

getDescriptorForType()

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

The bytes for inputUrl.

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>

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

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
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 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
NameDescription
valueEntityFilter
Returns
TypeDescription
ImportEntitiesRequest.Builder

mergeFrom(ImportEntitiesRequest other)

public ImportEntitiesRequest.Builder mergeFrom(ImportEntitiesRequest other)
Parameter
NameDescription
otherImportEntitiesRequest
Returns
TypeDescription
ImportEntitiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
ImportEntitiesRequest.Builder

putLabels(String key, String value)

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

Client-assigned labels.

map<string, string> labels = 2;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
ImportEntitiesRequest.Builder

removeLabels(String key)

public ImportEntitiesRequest.Builder removeLabels(String key)

Client-assigned labels.

map<string, string> labels = 2;

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

setField(Descriptors.FieldDescriptor field, Object value)

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

The inputUrl to set.

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

The bytes for inputUrl to set.

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

The projectId to set.

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

The bytes for projectId to set.

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

setUnknownFields(UnknownFieldSet unknownFields)

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