Package com.google.datastore.v1

Class Value

  • All Implemented Interfaces:
    ValueOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Value
extends com.google.protobuf.GeneratedMessageV3
implements ValueOrBuilder
     A message that can hold any of the supported value types and associated
 metadata.
    Protobuf type google.datastore.v1.Value
    See Also:
    Serialized Form

    • Field Detail

      • NULL_VALUE_FIELD_NUMBER

        public static final int NULL_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BOOLEAN_VALUE_FIELD_NUMBER

        public static final int BOOLEAN_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INTEGER_VALUE_FIELD_NUMBER

        public static final int INTEGER_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOUBLE_VALUE_FIELD_NUMBER

        public static final int DOUBLE_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIMESTAMP_VALUE_FIELD_NUMBER

        public static final int TIMESTAMP_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STRING_VALUE_FIELD_NUMBER

        public static final int STRING_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BLOB_VALUE_FIELD_NUMBER

        public static final int BLOB_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GEO_POINT_VALUE_FIELD_NUMBER

        public static final int GEO_POINT_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTITY_VALUE_FIELD_NUMBER

        public static final int ENTITY_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ARRAY_VALUE_FIELD_NUMBER

        public static final int ARRAY_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXCLUDE_FROM_INDEXES_FIELD_NUMBER

        public static final int EXCLUDE_FROM_INDEXES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • 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

      • hasNullValue

        public boolean hasNullValue()
         A null value.
        .google.protobuf.NullValue null_value = 11;
        Specified by:
        hasNullValue in interface ValueOrBuilder
        Returns:
        Whether the nullValue field is set.

      • getNullValueValue

        public int getNullValueValue()
         A null value.
        .google.protobuf.NullValue null_value = 11;
        Specified by:
        getNullValueValue in interface ValueOrBuilder
        Returns:
        The enum numeric value on the wire for nullValue.

      • getNullValue

        public com.google.protobuf.NullValue getNullValue()
         A null value.
        .google.protobuf.NullValue null_value = 11;
        Specified by:
        getNullValue in interface ValueOrBuilder
        Returns:
        The nullValue.

      • hasBooleanValue

        public boolean hasBooleanValue()
         A boolean value.
        bool boolean_value = 1;
        Specified by:
        hasBooleanValue in interface ValueOrBuilder
        Returns:
        Whether the booleanValue field is set.

      • getBooleanValue

        public boolean getBooleanValue()
         A boolean value.
        bool boolean_value = 1;
        Specified by:
        getBooleanValue in interface ValueOrBuilder
        Returns:
        The booleanValue.

      • hasIntegerValue

        public boolean hasIntegerValue()
         An integer value.
        int64 integer_value = 2;
        Specified by:
        hasIntegerValue in interface ValueOrBuilder
        Returns:
        Whether the integerValue field is set.

      • getIntegerValue

        public long getIntegerValue()
         An integer value.
        int64 integer_value = 2;
        Specified by:
        getIntegerValue in interface ValueOrBuilder
        Returns:
        The integerValue.

      • hasDoubleValue

        public boolean hasDoubleValue()
         A double value.
        double double_value = 3;
        Specified by:
        hasDoubleValue in interface ValueOrBuilder
        Returns:
        Whether the doubleValue field is set.

      • getDoubleValue

        public double getDoubleValue()
         A double value.
        double double_value = 3;
        Specified by:
        getDoubleValue in interface ValueOrBuilder
        Returns:
        The doubleValue.

      • hasTimestampValue

        public boolean hasTimestampValue()
         A timestamp value.
 When stored in the Datastore, precise only to microseconds;
 any additional precision is rounded down.
        .google.protobuf.Timestamp timestamp_value = 10;
        Specified by:
        hasTimestampValue in interface ValueOrBuilder
        Returns:
        Whether the timestampValue field is set.

      • getTimestampValue

        public com.google.protobuf.Timestamp getTimestampValue()
         A timestamp value.
 When stored in the Datastore, precise only to microseconds;
 any additional precision is rounded down.
        .google.protobuf.Timestamp timestamp_value = 10;
        Specified by:
        getTimestampValue in interface ValueOrBuilder
        Returns:
        The timestampValue.

      • getTimestampValueOrBuilder

        public com.google.protobuf.TimestampOrBuilder getTimestampValueOrBuilder()
         A timestamp value.
 When stored in the Datastore, precise only to microseconds;
 any additional precision is rounded down.
        .google.protobuf.Timestamp timestamp_value = 10;
        Specified by:
        getTimestampValueOrBuilder in interface ValueOrBuilder

      • hasKeyValue

        public boolean hasKeyValue()
         A key value.
        .google.datastore.v1.Key key_value = 5;
        Specified by:
        hasKeyValue in interface ValueOrBuilder
        Returns:
        Whether the keyValue field is set.

      • getKeyValue

        public Key getKeyValue()
         A key value.
        .google.datastore.v1.Key key_value = 5;
        Specified by:
        getKeyValue in interface ValueOrBuilder
        Returns:
        The keyValue.

      • hasStringValue

        public boolean hasStringValue()
         A UTF-8 encoded string value.
 When `exclude_from_indexes` is false (it is indexed) , may have at most
 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
        string string_value = 17;
        Specified by:
        hasStringValue in interface ValueOrBuilder
        Returns:
        Whether the stringValue field is set.

      • getStringValue

        public String getStringValue()
         A UTF-8 encoded string value.
 When `exclude_from_indexes` is false (it is indexed) , may have at most
 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
        string string_value = 17;
        Specified by:
        getStringValue in interface ValueOrBuilder
        Returns:
        The stringValue.

      • getStringValueBytes

        public com.google.protobuf.ByteString getStringValueBytes()
         A UTF-8 encoded string value.
 When `exclude_from_indexes` is false (it is indexed) , may have at most
 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
        string string_value = 17;
        Specified by:
        getStringValueBytes in interface ValueOrBuilder
        Returns:
        The bytes for stringValue.

      • hasBlobValue

        public boolean hasBlobValue()
         A blob value.
 May have at most 1,000,000 bytes.
 When `exclude_from_indexes` is false, may have at most 1500 bytes.
 In JSON requests, must be base64-encoded.
        bytes blob_value = 18;
        Specified by:
        hasBlobValue in interface ValueOrBuilder
        Returns:
        Whether the blobValue field is set.

      • getBlobValue

        public com.google.protobuf.ByteString getBlobValue()
         A blob value.
 May have at most 1,000,000 bytes.
 When `exclude_from_indexes` is false, may have at most 1500 bytes.
 In JSON requests, must be base64-encoded.
        bytes blob_value = 18;
        Specified by:
        getBlobValue in interface ValueOrBuilder
        Returns:
        The blobValue.

      • hasGeoPointValue

        public boolean hasGeoPointValue()
         A geo point value representing a point on the surface of Earth.
        .google.type.LatLng geo_point_value = 8;
        Specified by:
        hasGeoPointValue in interface ValueOrBuilder
        Returns:
        Whether the geoPointValue field is set.

      • getGeoPointValue

        public com.google.type.LatLng getGeoPointValue()
         A geo point value representing a point on the surface of Earth.
        .google.type.LatLng geo_point_value = 8;
        Specified by:
        getGeoPointValue in interface ValueOrBuilder
        Returns:
        The geoPointValue.

      • getGeoPointValueOrBuilder

        public com.google.type.LatLngOrBuilder getGeoPointValueOrBuilder()
         A geo point value representing a point on the surface of Earth.
        .google.type.LatLng geo_point_value = 8;
        Specified by:
        getGeoPointValueOrBuilder in interface ValueOrBuilder

      • hasEntityValue

        public boolean hasEntityValue()
         An entity value.

 - May have no key.
 - May have a key with an incomplete key path.
 - May have a reserved/read-only key.
        .google.datastore.v1.Entity entity_value = 6;
        Specified by:
        hasEntityValue in interface ValueOrBuilder
        Returns:
        Whether the entityValue field is set.

      • getEntityValue

        public Entity getEntityValue()
         An entity value.

 - May have no key.
 - May have a key with an incomplete key path.
 - May have a reserved/read-only key.
        .google.datastore.v1.Entity entity_value = 6;
        Specified by:
        getEntityValue in interface ValueOrBuilder
        Returns:
        The entityValue.

      • getEntityValueOrBuilder

        public EntityOrBuilder getEntityValueOrBuilder()
         An entity value.

 - May have no key.
 - May have a key with an incomplete key path.
 - May have a reserved/read-only key.
        .google.datastore.v1.Entity entity_value = 6;
        Specified by:
        getEntityValueOrBuilder in interface ValueOrBuilder

      • hasArrayValue

        public boolean hasArrayValue()
         An array value.
 Cannot contain another array value.
 A `Value` instance that sets field `array_value` must not set fields
 `meaning` or `exclude_from_indexes`.
        .google.datastore.v1.ArrayValue array_value = 9;
        Specified by:
        hasArrayValue in interface ValueOrBuilder
        Returns:
        Whether the arrayValue field is set.

      • getArrayValue

        public ArrayValue getArrayValue()
         An array value.
 Cannot contain another array value.
 A `Value` instance that sets field `array_value` must not set fields
 `meaning` or `exclude_from_indexes`.
        .google.datastore.v1.ArrayValue array_value = 9;
        Specified by:
        getArrayValue in interface ValueOrBuilder
        Returns:
        The arrayValue.

      • getArrayValueOrBuilder

        public ArrayValueOrBuilder getArrayValueOrBuilder()
         An array value.
 Cannot contain another array value.
 A `Value` instance that sets field `array_value` must not set fields
 `meaning` or `exclude_from_indexes`.
        .google.datastore.v1.ArrayValue array_value = 9;
        Specified by:
        getArrayValueOrBuilder in interface ValueOrBuilder

      • getMeaning

        public int getMeaning()
         The `meaning` field should only be populated for backwards compatibility.
        int32 meaning = 14;
        Specified by:
        getMeaning in interface ValueOrBuilder
        Returns:
        The meaning.

      • getExcludeFromIndexes

        public boolean getExcludeFromIndexes()
         If the value should be excluded from all indexes including those defined
 explicitly.
        bool exclude_from_indexes = 19;
        Specified by:
        getExcludeFromIndexes in interface ValueOrBuilder
        Returns:
        The excludeFromIndexes.

      • 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 Value parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Value parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Value parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Value parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Value parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Value parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Value parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Value.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Value.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Value.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Value getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Value> 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 Value getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder