Class LookupRequest (2.30.0)

publicfinalclass LookupRequestextendsGeneratedMessageV3implementsLookupRequestOrBuilder

The request for Datastore.Lookup.

Protobuf type google.datastore.v1.LookupRequest

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

DATABASE_ID_FIELD_NUMBER

publicstaticfinalintDATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

KEYS_FIELD_NUMBER

publicstaticfinalintKEYS_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

publicstaticfinalintPROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_MASK_FIELD_NUMBER

publicstaticfinalintPROPERTY_MASK_FIELD_NUMBER
Field Value
Type Description
int

READ_OPTIONS_FIELD_NUMBER

publicstaticfinalintREAD_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticLookupRequestgetDefaultInstance()
Returns
Type Description
LookupRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticLookupRequest.BuildernewBuilder()
Returns
Type Description
LookupRequest.Builder

newBuilder(LookupRequest prototype)

publicstaticLookupRequest.BuildernewBuilder(LookupRequestprototype)
Parameter
Name Description
prototype LookupRequest
Returns
Type Description
LookupRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticLookupRequestparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticLookupRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticLookupRequestparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticLookupRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticLookupRequestparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticLookupRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticLookupRequestparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticLookupRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticLookupRequestparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticLookupRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticLookupRequestparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticLookupRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<LookupRequest>parser()
Returns
Type Description
Parser<LookupRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatabaseId()

publicStringgetDatabaseId()

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

string database_id = 9;

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

publicByteStringgetDatabaseIdBytes()

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

string database_id = 9;

Returns
Type Description
ByteString

The bytes for databaseId.

getDefaultInstanceForType()

publicLookupRequestgetDefaultInstanceForType()
Returns
Type Description
LookupRequest

getKeys(int index)

publicKeygetKeys(intindex)

Required. Keys of entities to look up.

repeated .google.datastore.v1.Key keys = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Key

getKeysCount()

publicintgetKeysCount()

Required. Keys of entities to look up.

repeated .google.datastore.v1.Key keys = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getKeysList()

publicList<Key>getKeysList()

Required. Keys of entities to look up.

repeated .google.datastore.v1.Key keys = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Key>

getKeysOrBuilder(int index)

publicKeyOrBuildergetKeysOrBuilder(intindex)

Required. Keys of entities to look up.

repeated .google.datastore.v1.Key keys = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
KeyOrBuilder

getKeysOrBuilderList()

publicList<?extendsKeyOrBuilder>getKeysOrBuilderList()

Required. Keys of entities to look up.

repeated .google.datastore.v1.Key keys = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.datastore.v1.KeyOrBuilder>

getParserForType()

publicParser<LookupRequest>getParserForType()
Returns
Type Description
Parser<LookupRequest>
Overrides

getProjectId()

publicStringgetProjectId()

Required. The ID of the project against which to make the request.

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

Returns
Type Description
String

The projectId.

getProjectIdBytes()

publicByteStringgetProjectIdBytes()

Required. The ID of the project against which to make the request.

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

Returns
Type Description
ByteString

The bytes for projectId.

getPropertyMask()

publicPropertyMaskgetPropertyMask()

The properties to return. Defaults to returning all properties.

If this field is set and an entity has a property not referenced in the mask, it will be absent from [LookupResponse.found.entity.properties][].

The entity's key is always returned.

.google.datastore.v1.PropertyMask property_mask = 5;

Returns
Type Description
PropertyMask

The propertyMask.

getPropertyMaskOrBuilder()

publicPropertyMaskOrBuildergetPropertyMaskOrBuilder()

The properties to return. Defaults to returning all properties.

If this field is set and an entity has a property not referenced in the mask, it will be absent from [LookupResponse.found.entity.properties][].

The entity's key is always returned.

.google.datastore.v1.PropertyMask property_mask = 5;

Returns
Type Description
PropertyMaskOrBuilder

getReadOptions()

publicReadOptionsgetReadOptions()

The options for this lookup request.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
ReadOptions

The readOptions.

getReadOptionsOrBuilder()

publicReadOptionsOrBuildergetReadOptionsOrBuilder()

The options for this lookup request.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
ReadOptionsOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

hasPropertyMask()

publicbooleanhasPropertyMask()

The properties to return. Defaults to returning all properties.

If this field is set and an entity has a property not referenced in the mask, it will be absent from [LookupResponse.found.entity.properties][].

The entity's key is always returned.

.google.datastore.v1.PropertyMask property_mask = 5;

Returns
Type Description
boolean

Whether the propertyMask field is set.

hasReadOptions()

publicbooleanhasReadOptions()

The options for this lookup request.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
boolean

Whether the readOptions field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicLookupRequest.BuildernewBuilderForType()
Returns
Type Description
LookupRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedLookupRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LookupRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicLookupRequest.BuildertoBuilder()
Returns
Type Description
LookupRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.