Package com.google.protobuf

Class Value

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ValueOrBuilder, java.io.Serializable
    public final class Value
extends com.google.protobuf.GeneratedMessageV3
implements ValueOrBuilder
     `Value` represents a dynamically typed value which can be either
 null, a number, a string, a boolean, a recursive struct value, or a
 list of values. A producer of value is expected to set one of these
 variants. Absence of any variant indicates an error.

 The JSON representation for `Value` is JSON value.
    Protobuf type google.protobuf.Value
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Value.Builder
      `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
      static class  Value.KindCase  

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      boolean getBoolValue()
      Represents a boolean value.
      static Value getDefaultInstance()  
      Value getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      Value.KindCase getKindCase()  
      ListValue getListValue()
      Represents a repeated `Value`.
      ListValueOrBuilder getListValueOrBuilder()
      Represents a repeated `Value`.
      NullValue getNullValue()
      Represents a null value.
      int getNullValueValue()
      Represents a null value.
      double getNumberValue()
      Represents a double value.
      com.google.protobuf.Parser<Value> getParserForType()  
      int getSerializedSize()  
      java.lang.String getStringValue()
      Represents a string value.
      com.google.protobuf.ByteString getStringValueBytes()
      Represents a string value.
      Struct getStructValue()
      Represents a structured value.
      StructOrBuilder getStructValueOrBuilder()
      Represents a structured value.
      boolean hasBoolValue()
      Represents a boolean value.
      int hashCode()  
      boolean hasListValue()
      Represents a repeated `Value`.
      boolean hasNullValue()
      Represents a null value.
      boolean hasNumberValue()
      Represents a double value.
      boolean hasStringValue()
      Represents a string value.
      boolean hasStructValue()
      Represents a structured value.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Value.Builder newBuilder()  
      static Value.Builder newBuilder​(Value prototype)  
      Value.Builder newBuilderForType()  
      protected Value.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Value parseDelimitedFrom​(java.io.InputStream input)  
      static Value parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Value parseFrom​(byte[] data)  
      static Value parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Value parseFrom​(com.google.protobuf.ByteString data)  
      static Value parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Value parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Value parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Value parseFrom​(java.io.InputStream input)  
      static Value parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Value parseFrom​(java.nio.ByteBuffer data)  
      static Value parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Value> parser()  
      Value.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, 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

    • Method Detail

      • newInstance

        protected java.lang.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()
         Represents a null value.
        .google.protobuf.NullValue null_value = 1;
        Specified by:
        hasNullValue in interface ValueOrBuilder
        Returns:
        Whether the nullValue field is set.

      • getNullValueValue

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

      • getNullValue

        public NullValue getNullValue()
         Represents a null value.
        .google.protobuf.NullValue null_value = 1;
        Specified by:
        getNullValue in interface ValueOrBuilder
        Returns:
        The nullValue.

      • hasNumberValue

        public boolean hasNumberValue()
         Represents a double value.
        double number_value = 2;
        Specified by:
        hasNumberValue in interface ValueOrBuilder
        Returns:
        Whether the numberValue field is set.

      • getNumberValue

        public double getNumberValue()
         Represents a double value.
        double number_value = 2;
        Specified by:
        getNumberValue in interface ValueOrBuilder
        Returns:
        The numberValue.

      • hasStringValue

        public boolean hasStringValue()
         Represents a string value.
        string string_value = 3;
        Specified by:
        hasStringValue in interface ValueOrBuilder
        Returns:
        Whether the stringValue field is set.

      • getStringValue

        public java.lang.String getStringValue()
         Represents a string value.
        string string_value = 3;
        Specified by:
        getStringValue in interface ValueOrBuilder
        Returns:
        The stringValue.

      • getStringValueBytes

        public com.google.protobuf.ByteString getStringValueBytes()
         Represents a string value.
        string string_value = 3;
        Specified by:
        getStringValueBytes in interface ValueOrBuilder
        Returns:
        The bytes for stringValue.

      • hasBoolValue

        public boolean hasBoolValue()
         Represents a boolean value.
        bool bool_value = 4;
        Specified by:
        hasBoolValue in interface ValueOrBuilder
        Returns:
        Whether the boolValue field is set.

      • getBoolValue

        public boolean getBoolValue()
         Represents a boolean value.
        bool bool_value = 4;
        Specified by:
        getBoolValue in interface ValueOrBuilder
        Returns:
        The boolValue.

      • hasStructValue

        public boolean hasStructValue()
         Represents a structured value.
        .google.protobuf.Struct struct_value = 5;
        Specified by:
        hasStructValue in interface ValueOrBuilder
        Returns:
        Whether the structValue field is set.

      • getStructValue

        public Struct getStructValue()
         Represents a structured value.
        .google.protobuf.Struct struct_value = 5;
        Specified by:
        getStructValue in interface ValueOrBuilder
        Returns:
        The structValue.

      • hasListValue

        public boolean hasListValue()
         Represents a repeated `Value`.
        .google.protobuf.ListValue list_value = 6;
        Specified by:
        hasListValue in interface ValueOrBuilder
        Returns:
        Whether the listValue field is set.

      • getListValue

        public ListValue getListValue()
         Represents a repeated `Value`.
        .google.protobuf.ListValue list_value = 6;
        Specified by:
        getListValue in interface ValueOrBuilder
        Returns:
        The listValue.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Value parseFrom​(java.nio.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​(java.io.InputStream input)
                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static Value parseDelimitedFrom​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Value parseDelimitedFrom​(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Value parseFrom​(com.google.protobuf.CodedInputStream input)
                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Value parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException
        Throws:
        java.io.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