Class LookupRequest.Builder (2.20.0)

public static final class LookupRequest.Builder extends GeneratedMessageV3.Builder<LookupRequest.Builder> implements LookupRequestOrBuilder

The request for Datastore.Lookup.

Protobuf type google.datastore.v1.LookupRequest

Static Methods

getDescriptor()

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

Methods

addAllKeys(Iterable<? extends Key> values)

public LookupRequest.Builder addAllKeys(Iterable<? extends Key> values)

Required. Keys of entities to look up.

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

Parameter
Name Description
values Iterable<? extends com.google.datastore.v1.Key>
Returns
Type Description
LookupRequest.Builder

addKeys(Key value)

public LookupRequest.Builder addKeys(Key value)

Required. Keys of entities to look up.

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

Parameter
Name Description
value Key
Returns
Type Description
LookupRequest.Builder

addKeys(Key.Builder builderForValue)

public LookupRequest.Builder addKeys(Key.Builder builderForValue)

Required. Keys of entities to look up.

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

Parameter
Name Description
builderForValue Key.Builder
Returns
Type Description
LookupRequest.Builder

addKeys(int index, Key value)

public LookupRequest.Builder addKeys(int index, Key value)

Required. Keys of entities to look up.

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

Parameters
Name Description
index int
value Key
Returns
Type Description
LookupRequest.Builder

addKeys(int index, Key.Builder builderForValue)

public LookupRequest.Builder addKeys(int index, Key.Builder builderForValue)

Required. Keys of entities to look up.

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

Parameters
Name Description
index int
builderForValue Key.Builder
Returns
Type Description
LookupRequest.Builder

addKeysBuilder()

public Key.Builder addKeysBuilder()

Required. Keys of entities to look up.

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

Returns
Type Description
Key.Builder

addKeysBuilder(int index)

public Key.Builder addKeysBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public LookupRequest build()
Returns
Type Description
LookupRequest

buildPartial()

public LookupRequest buildPartial()
Returns
Type Description
LookupRequest

clear()

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

clearDatabaseId()

public LookupRequest.Builder clearDatabaseId()

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
LookupRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearKeys()

public LookupRequest.Builder clearKeys()

Required. Keys of entities to look up.

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

Returns
Type Description
LookupRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProjectId()

public LookupRequest.Builder clearProjectId()

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

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

Returns
Type Description
LookupRequest.Builder

This builder for chaining.

clearPropertyMask()

public LookupRequest.Builder clearPropertyMask()

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
LookupRequest.Builder

clearReadOptions()

public LookupRequest.Builder clearReadOptions()

The options for this lookup request.

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

Returns
Type Description
LookupRequest.Builder

clone()

public LookupRequest.Builder clone()
Returns
Type Description
LookupRequest.Builder
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

getDescriptorForType()

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

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

getKeysBuilder(int index)

public Key.Builder getKeysBuilder(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.Builder

getKeysBuilderList()

public List<Key.Builder> getKeysBuilderList()

Required. Keys of entities to look up.

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

Returns
Type Description
List<Builder>

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>

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.

getPropertyMaskBuilder()

public PropertyMask.Builder getPropertyMaskBuilder()

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

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.

getReadOptionsBuilder()

public ReadOptions.Builder getReadOptionsBuilder()

The options for this lookup request.

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

Returns
Type Description
ReadOptions.Builder

getReadOptionsOrBuilder()

public ReadOptionsOrBuilder getReadOptionsOrBuilder()

The options for this lookup request.

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

Returns
Type Description
ReadOptionsOrBuilder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LookupRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePropertyMask(PropertyMask value)

public LookupRequest.Builder mergePropertyMask(PropertyMask value)

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;

Parameter
Name Description
value PropertyMask
Returns
Type Description
LookupRequest.Builder

mergeReadOptions(ReadOptions value)

public LookupRequest.Builder mergeReadOptions(ReadOptions value)

The options for this lookup request.

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

Parameter
Name Description
value ReadOptions
Returns
Type Description
LookupRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeKeys(int index)

public LookupRequest.Builder removeKeys(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
LookupRequest.Builder

setDatabaseId(String value)

public LookupRequest.Builder setDatabaseId(String value)

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;

Parameter
Name Description
value String

The databaseId to set.

Returns
Type Description
LookupRequest.Builder

This builder for chaining.

setDatabaseIdBytes(ByteString value)

public LookupRequest.Builder setDatabaseIdBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for databaseId to set.

Returns
Type Description
LookupRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setKeys(int index, Key value)

public LookupRequest.Builder setKeys(int index, Key value)

Required. Keys of entities to look up.

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

Parameters
Name Description
index int
value Key
Returns
Type Description
LookupRequest.Builder

setKeys(int index, Key.Builder builderForValue)

public LookupRequest.Builder setKeys(int index, Key.Builder builderForValue)

Required. Keys of entities to look up.

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

Parameters
Name Description
index int
builderForValue Key.Builder
Returns
Type Description
LookupRequest.Builder

setProjectId(String value)

public LookupRequest.Builder setProjectId(String value)

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

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

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
LookupRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public LookupRequest.Builder setProjectIdBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
LookupRequest.Builder

This builder for chaining.

setPropertyMask(PropertyMask value)

public LookupRequest.Builder setPropertyMask(PropertyMask value)

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;

Parameter
Name Description
value PropertyMask
Returns
Type Description
LookupRequest.Builder

setPropertyMask(PropertyMask.Builder builderForValue)

public LookupRequest.Builder setPropertyMask(PropertyMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue PropertyMask.Builder
Returns
Type Description
LookupRequest.Builder

setReadOptions(ReadOptions value)

public LookupRequest.Builder setReadOptions(ReadOptions value)

The options for this lookup request.

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

Parameter
Name Description
value ReadOptions
Returns
Type Description
LookupRequest.Builder

setReadOptions(ReadOptions.Builder builderForValue)

public LookupRequest.Builder setReadOptions(ReadOptions.Builder builderForValue)

The options for this lookup request.

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

Parameter
Name Description
builderForValue ReadOptions.Builder
Returns
Type Description
LookupRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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