Package com.google.protobuf

Class Value

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.protobuf.Value
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ValueOrBuilder, 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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 enum 
    Value.KindCase
     

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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
    BOOL_VALUE_FIELD_NUMBER
     
    static final int
    LIST_VALUE_FIELD_NUMBER
     
    static final int
    NULL_VALUE_FIELD_NUMBER
     
    static final int
    NUMBER_VALUE_FIELD_NUMBER
     
    static final int
    STRING_VALUE_FIELD_NUMBER
     
    static final int
    STRUCT_VALUE_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)
     
    boolean
    getBoolValue()
    Represents a boolean value.
    static Value
    getDefaultInstance()
     
    Value
    getDefaultInstanceForType()
     
    static final 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()
     
    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.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    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()
     
    final 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 Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Value
    parseDelimitedFrom(InputStream input)
     
    static Value
    parseDelimitedFrom(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(InputStream input)
     
    static Value
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Value
    parseFrom(ByteBuffer data)
     
    static Value
    parseFrom(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, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

  • Field Details

    • NULL_VALUE_FIELD_NUMBER

      public static final int NULL_VALUE_FIELD_NUMBER
      See Also:

    • NUMBER_VALUE_FIELD_NUMBER

      public static final int NUMBER_VALUE_FIELD_NUMBER
      See Also:

    • STRING_VALUE_FIELD_NUMBER

      public static final int STRING_VALUE_FIELD_NUMBER
      See Also:

    • BOOL_VALUE_FIELD_NUMBER

      public static final int BOOL_VALUE_FIELD_NUMBER
      See Also:

    • STRUCT_VALUE_FIELD_NUMBER

      public static final int STRUCT_VALUE_FIELD_NUMBER
      See Also:

    • LIST_VALUE_FIELD_NUMBER

      public static final int LIST_VALUE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields 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

    • getKindCase

      public Value.KindCase getKindCase()
      Specified by:
      getKindCase in interface ValueOrBuilder

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

    • getStructValueOrBuilder

      public StructOrBuilder getStructValueOrBuilder()
       Represents a structured value.
      .google.protobuf.Struct struct_value = 5;
      Specified by:
      getStructValueOrBuilder in interface ValueOrBuilder

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

    • getListValueOrBuilder

      public ListValueOrBuilder getListValueOrBuilder()
       Represents a repeated `Value`.
      .google.protobuf.ListValue list_value = 6;
      Specified by:
      getListValueOrBuilder in interface ValueOrBuilder

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Value parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static Value.Builder newBuilder()

    • newBuilder

      public static Value.Builder newBuilder(Value prototype)

    • 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