Package com.google.datastore.v1

Class LookupRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.datastore.v1.LookupRequest

All Implemented Interfaces:

LookupRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class LookupRequest
extends com.google.protobuf.GeneratedMessageV3
implements LookupRequestOrBuilder

 The request for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].
 

Protobuf type google.datastore.v1.LookupRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LookupRequest.Builder	The request for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DATABASE_ID_FIELD_NUMBER
static final int	KEYS_FIELD_NUMBER
static final int	PROJECT_ID_FIELD_NUMBER
static final int	PROPERTY_MASK_FIELD_NUMBER
static final int	READ_OPTIONS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDatabaseId()	The ID of the database against which to make the request.
com.google.protobuf.ByteString	getDatabaseIdBytes()	The ID of the database against which to make the request.
static LookupRequest	getDefaultInstance()
LookupRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Key	getKeys(int index)	Required.
int	getKeysCount()	Required.
List<Key>	getKeysList()	Required.
KeyOrBuilder	getKeysOrBuilder(int index)	Required.
List<? extends KeyOrBuilder>	getKeysOrBuilderList()	Required.
com.google.protobuf.Parser<LookupRequest>	getParserForType()
String	getProjectId()	Required.
com.google.protobuf.ByteString	getProjectIdBytes()	Required.
PropertyMask	getPropertyMask()	The properties to return.
PropertyMaskOrBuilder	getPropertyMaskOrBuilder()	The properties to return.
ReadOptions	getReadOptions()	The options for this lookup request.
ReadOptionsOrBuilder	getReadOptionsOrBuilder()	The options for this lookup request.
int	getSerializedSize()
int	hashCode()
boolean	hasPropertyMask()	The properties to return.
boolean	hasReadOptions()	The options for this lookup request.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static LookupRequest.Builder	newBuilder()
static LookupRequest.Builder	newBuilder(LookupRequest prototype)
LookupRequest.Builder	newBuilderForType()
protected LookupRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LookupRequest	parseDelimitedFrom(InputStream input)
static LookupRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LookupRequest	parseFrom(byte[] data)
static LookupRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LookupRequest	parseFrom(com.google.protobuf.ByteString data)
static LookupRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LookupRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static LookupRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LookupRequest	parseFrom(InputStream input)
static LookupRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LookupRequest	parseFrom(ByteBuffer data)
static LookupRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LookupRequest>	parser()
LookupRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

See Also:

• Constant Field Values

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER

See Also:

• Constant Field Values

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

KEYS_FIELD_NUMBER

public static final int KEYS_FIELD_NUMBER

See Also:

• Constant Field Values

PROPERTY_MASK_FIELD_NUMBER

public static final int PROPERTY_MASK_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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];

Specified by:

getProjectId in interface LookupRequestOrBuilder

Returns:

The projectId.

getProjectIdBytes

public com.google.protobuf.ByteString getProjectIdBytes()

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

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

Specified by:

getProjectIdBytes in interface LookupRequestOrBuilder

Returns:

The bytes for projectId.

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;

Specified by:

getDatabaseId in interface LookupRequestOrBuilder

Returns:

The databaseId.

getDatabaseIdBytes

public com.google.protobuf.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;

Specified by:

getDatabaseIdBytes in interface LookupRequestOrBuilder

Returns:

The bytes for databaseId.

hasReadOptions

public boolean hasReadOptions()

 The options for this lookup request.
 

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

Specified by:

hasReadOptions in interface LookupRequestOrBuilder

Returns:

Whether the readOptions field is set.

getReadOptions

public ReadOptions getReadOptions()

 The options for this lookup request.
 

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

Specified by:

getReadOptions in interface LookupRequestOrBuilder

Returns:

The readOptions.

getReadOptionsOrBuilder

public ReadOptionsOrBuilder getReadOptionsOrBuilder()

 The options for this lookup request.
 

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

Specified by:

getReadOptionsOrBuilder in interface LookupRequestOrBuilder

getKeysList

public List<Key> getKeysList()

 Required. Keys of entities to look up.
 

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

Specified by:

getKeysList in interface LookupRequestOrBuilder

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];

Specified by:

getKeysOrBuilderList in interface LookupRequestOrBuilder

getKeysCount

public int getKeysCount()

 Required. Keys of entities to look up.
 

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

Specified by:

getKeysCount in interface LookupRequestOrBuilder

getKeys

public Key getKeys(int index)

 Required. Keys of entities to look up.
 

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

Specified by:

getKeys in interface LookupRequestOrBuilder

getKeysOrBuilder

public KeyOrBuilder getKeysOrBuilder(int index)

 Required. Keys of entities to look up.
 

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

Specified by:

getKeysOrBuilder in interface LookupRequestOrBuilder

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;

Specified by:

hasPropertyMask in interface LookupRequestOrBuilder

Returns:

Whether the propertyMask field is set.

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;

Specified by:

getPropertyMask in interface LookupRequestOrBuilder

Returns:

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;

Specified by:

getPropertyMaskOrBuilder in interface LookupRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LookupRequest parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LookupRequest parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LookupRequest parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LookupRequest parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LookupRequest parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LookupRequest parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LookupRequest parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static LookupRequest parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static LookupRequest parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static LookupRequest parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static LookupRequest parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static LookupRequest parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public LookupRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LookupRequest.Builder newBuilder()

newBuilder

public static LookupRequest.Builder newBuilder(LookupRequest prototype)

toBuilder

public LookupRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LookupRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LookupRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<LookupRequest> parser()

getParserForType

public com.google.protobuf.Parser<LookupRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LookupRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder