Class LookupRequest (2.21.2)

public final class LookupRequest extends GeneratedMessageV3 implements LookupRequestOrBuilder

The request for Datastore.Lookup.

Protobuf type google.datastore.v1.LookupRequest

Static Fields

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

KEYS_FIELD_NUMBER

public static final int KEYS_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_MASK_FIELD_NUMBER

public static final int PROPERTY_MASK_FIELD_NUMBER
Field Value
Type Description
int

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LookupRequest getDefaultInstance()
Returns
Type Description
LookupRequest

getDescriptor()

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

newBuilder()

public static LookupRequest.Builder newBuilder()
Returns
Type Description
LookupRequest.Builder

newBuilder(LookupRequest prototype)

public static LookupRequest.Builder newBuilder(LookupRequest prototype)
Parameter
Name Description
prototype LookupRequest
Returns
Type Description
LookupRequest.Builder

parseDelimitedFrom(InputStream input)

public static LookupRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LookupRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LookupRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LookupRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LookupRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LookupRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LookupRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LookupRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LookupRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LookupRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LookupRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LookupRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LookupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LookupRequest> parser()
Returns
Type Description
Parser<LookupRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatabaseId()

public String getDatabaseId()

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

public ByteString getDatabaseIdBytes()

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

public LookupRequest getDefaultInstanceForType()
Returns
Type Description
LookupRequest

getKeys(int index)

public Key getKeys(int index)

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

public int getKeysCount()

Required. Keys of entities to look up.

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

Returns
Type Description
int

getKeysList()

public List<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)

public KeyOrBuilder getKeysOrBuilder(int index)

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

public List<? extends KeyOrBuilder> 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()

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

getProjectId()

public String getProjectId()

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

public ByteString getProjectIdBytes()

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

public PropertyMask getPropertyMask()

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

public PropertyMaskOrBuilder getPropertyMaskOrBuilder()

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

public ReadOptions getReadOptions()

The options for this lookup request.

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

Returns
Type Description
ReadOptions

The readOptions.

getReadOptionsOrBuilder()

public ReadOptionsOrBuilder getReadOptionsOrBuilder()

The options for this lookup request.

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

Returns
Type Description
ReadOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPropertyMask()

public boolean hasPropertyMask()

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

public boolean hasReadOptions()

The options for this lookup request.

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

Returns
Type Description
boolean

Whether the readOptions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LookupRequest.Builder newBuilderForType()
Returns
Type Description
LookupRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LookupRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LookupRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LookupRequest.Builder toBuilder()
Returns
Type Description
LookupRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException