Class ImportEntitiesRequest (2.17.6)

public final class ImportEntitiesRequest extends GeneratedMessageV3 implements ImportEntitiesRequestOrBuilder

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

Protobuf type google.datastore.admin.v1.ImportEntitiesRequest

Static Fields

ENTITY_FILTER_FIELD_NUMBER

public static final int ENTITY_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_URL_FIELD_NUMBER

public static final int INPUT_URL_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImportEntitiesRequest getDefaultInstance()
Returns
TypeDescription
ImportEntitiesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ImportEntitiesRequest.Builder newBuilder()
Returns
TypeDescription
ImportEntitiesRequest.Builder

newBuilder(ImportEntitiesRequest prototype)

public static ImportEntitiesRequest.Builder newBuilder(ImportEntitiesRequest prototype)
Parameter
NameDescription
prototypeImportEntitiesRequest
Returns
TypeDescription
ImportEntitiesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportEntitiesRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportEntitiesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ImportEntitiesRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportEntitiesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportEntitiesRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportEntitiesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportEntitiesRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportEntitiesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ImportEntitiesRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportEntitiesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ImportEntitiesRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportEntitiesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ImportEntitiesRequest> parser()
Returns
TypeDescription
Parser<ImportEntitiesRequest>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Client-assigned labels.

map<string, string> labels = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ImportEntitiesRequest getDefaultInstanceForType()
Returns
TypeDescription
ImportEntitiesRequest

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.

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

getParserForType()

public Parser<ImportEntitiesRequest> getParserForType()
Returns
TypeDescription
Parser<ImportEntitiesRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportEntitiesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ImportEntitiesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException