Interface LookupRequestOrBuilder (2.25.1)

public interface LookupRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDatabaseId()

public abstract 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 abstract 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.

getKeys(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ReadOptions getReadOptions()

The options for this lookup request.

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

Returns
Type Description
ReadOptions

The readOptions.

getReadOptionsOrBuilder()

public abstract ReadOptionsOrBuilder getReadOptionsOrBuilder()

The options for this lookup request.

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

Returns
Type Description
ReadOptionsOrBuilder

hasPropertyMask()

public abstract 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 abstract 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.