Value

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.protobuf.Value

All Implemented Interfaces:: Message , MessageLite , MessageLiteOrBuilder , 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 that
 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 and 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.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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOOL_VALUE_FIELD_NUMBER`
`static int`	`LIST_VALUE_FIELD_NUMBER`
`static int`	`NULL_VALUE_FIELD_NUMBER`
`static int`	`NUMBER_VALUE_FIELD_NUMBER`
`static int`	`STRING_VALUE_FIELD_NUMBER`
`static int`	`STRUCT_VALUE_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals (java.lang.Object obj)` Compares the specified object with this message for equality.
`boolean`	`getBoolValue ()` Represents a boolean value.
`static Value`	`getDefaultInstance ()`
`Value`	`getDefaultInstanceForType ()` Get an instance of the type with no fields set.
`static 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.
`Parser < Value >`	`getParserForType ()` Gets the parser for a message of the same type as this message.
`int`	`getSerializedSize ()` Get the number of bytes required to encode this message.
`java.lang.String`	`getStringValue ()` Represents a string value.
`ByteString`	`getStringValueBytes ()` Represents a string value.
`Struct`	`getStructValue ()` Represents a structured value.
`StructOrBuilder`	`getStructValueOrBuilder ()` Represents a structured value.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields ()` Get the `UnknownFieldSet` for this message.
`boolean`	`hasBoolValue ()` Represents a boolean value.
`int`	`hashCode ()` Returns the hash code value for this message.
`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.
`boolean`	`isInitialized ()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`static Value.Builder`	`newBuilder ()`
`static Value.Builder`	`newBuilder ( Value prototype)`
`Value.Builder`	`newBuilderForType ()` Constructs a new builder for a message of the same type as this message.
`static Value`	`parseDelimitedFrom (java.io.InputStream input)`
`static Value`	`parseDelimitedFrom (java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Value`	`parseFrom (byte[] data)`
`static Value`	`parseFrom (byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Value`	`parseFrom (java.nio.ByteBuffer data)`
`static Value`	`parseFrom (java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Value`	`parseFrom ( ByteString data)`
`static Value`	`parseFrom ( ByteString data, ExtensionRegistryLite extensionRegistry)`
`static Value`	`parseFrom ( CodedInputStream input)`
`static Value`	`parseFrom ( CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static Value`	`parseFrom (java.io.InputStream input)`
`static Value`	`parseFrom (java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser < Value >`	`parser ()`
`Value.Builder`	`toBuilder ()` Constructs a builder initialized with the current message.
`void`	`writeTo ( CodedOutputStream output)` Serializes the message and writes it to `output` .

Methods inherited from class com.google.protobuf.GeneratedMessageV3
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from class com.google.protobuf. AbstractMessage
findInitializationErrors , getInitializationErrorString , toString

Methods inherited from class com.google.protobuf. AbstractMessageLite
toByteArray , toByteString , writeDelimitedTo , writeTo

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf. MessageOrBuilder
findInitializationErrors , getAllFields , getDescriptorForType , getField , getInitializationErrorString , getOneofFieldDescriptor , getRepeatedField , getRepeatedFieldCount , hasField , hasOneof

Methods inherited from interface com.google.protobuf. MessageLite
toByteArray , toByteString , writeDelimitedTo , writeTo

- Field Detail
  - NULL_VALUE_FIELD_NUMBER
```
public static final int NULL_VALUE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - NUMBER_VALUE_FIELD_NUMBER
```
public static final int NUMBER_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
  - BOOL_VALUE_FIELD_NUMBER
```
public static final int BOOL_VALUE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - STRUCT_VALUE_FIELD_NUMBER
```
public static final int STRUCT_VALUE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - LIST_VALUE_FIELD_NUMBER
```
public static final int LIST_VALUE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
    Description copied from interface: MessageOrBuilder
    
    Get the UnknownFieldSet for this message.
    
    Specified by:
    
    getUnknownFields in interface MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final  Descriptors.Descriptor 
 getDescriptor()
```
  - 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 java.lang.String getStringValue()
```
```
Represents a string value.
```
    string string_value = 3;
    Specified by:
    
    getStringValue in interface ValueOrBuilder
    
    Returns:
    
    The stringValue.
  - getStringValueBytes
```
public  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()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo( CodedOutputStream 
 output)
             throws java.io.IOException
```
    Description copied from interface: MessageLite
    
    Serializes the message and writes it to output . This does not flush or close the stream.
    
    Specified by:
    
    writeTo in interface MessageLite
    
    Overrides:
    
    writeTo in class com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    java.io.IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Description copied from interface: MessageLite
    
    Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.
    
    Specified by:
    
    getSerializedSize in interface MessageLite
    
    Overrides:
    
    getSerializedSize in class com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from interface: Message
    
    Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType() ) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.
    
    Specified by:
    
    equals in interface Message
    
    Overrides:
    
    equals in class AbstractMessage
    
    Parameters:
    
    obj - object to be compared for equality with this message
    
    Returns:
    
    true if the specified object is equal to this message
  - hashCode
```
public int hashCode()
```
    Description copied from interface: Message
    
    Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.
    
    Specified by:
    
    hashCode in interface Message
    
    Overrides:
    
    hashCode in class AbstractMessage
    
    Returns:
    
    the hash code value for this message
    
    See Also:
    
    Map.hashCode()
  - parseFrom
```
public static  Value 
 parseFrom(java.nio.ByteBuffer data)
                       throws InvalidProtocolBufferException 
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static  Value 
 parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite 
 extensionRegistry)
                       throws InvalidProtocolBufferException 
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static  Value 
 parseFrom( ByteString 
 data)
                       throws InvalidProtocolBufferException 
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static  Value 
 parseFrom( ByteString 
 data, ExtensionRegistryLite 
 extensionRegistry)
                       throws InvalidProtocolBufferException 
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static  Value 
 parseFrom(byte[] data)
                       throws InvalidProtocolBufferException 
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static  Value 
 parseFrom(byte[] data, ExtensionRegistryLite 
 extensionRegistry)
                       throws InvalidProtocolBufferException 
```
    Throws:
    
    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, 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, ExtensionRegistryLite 
 extensionRegistry)
                                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static  Value 
 parseFrom( CodedInputStream 
 input)
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static  Value 
 parseFrom( CodedInputStream 
 input, ExtensionRegistryLite 
 extensionRegistry)
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - newBuilderForType
```
public  Value.Builder 
 newBuilderForType()
```
    Description copied from interface: MessageLite
    
    Constructs a new builder for a message of the same type as this message.
    
    Specified by:
    
    newBuilderForType in interface Message
    
    Specified by:
    
    newBuilderForType in interface MessageLite
  - newBuilder
```
public static  Value.Builder 
 newBuilder()
```
  - newBuilder
```
public static  Value.Builder 
 newBuilder( Value 
 prototype)
```
  - toBuilder
```
public  Value.Builder 
 toBuilder()
```
    Description copied from interface: MessageLite
    
    Constructs a builder initialized with the current message. Use this to derive a new message from the current one.
    
    Specified by:
    
    toBuilder in interface Message
    
    Specified by:
    
    toBuilder in interface MessageLite
  - getDefaultInstance
```
public static  Value 
 getDefaultInstance()
```
  - parser
```
public static  Parser 
< Value 
> parser()
```
  - getParserForType
```
public  Parser 
< Value 
> getParserForType()
```
    Description copied from interface: MessageLite
    
    Gets the parser for a message of the same type as this message.
    
    Specified by:
    
    getParserForType in interface Message
    
    Specified by:
    
    getParserForType in interface MessageLite
    
    Overrides:
    
    getParserForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstanceForType
```
public  Value 
 getDefaultInstanceForType()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Create a Mobile Website

View Site in Mobile | Classic

Class Value

Nested Class Summary

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

Field Summary

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf. AbstractMessage

Methods inherited from class com.google.protobuf. AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf. MessageOrBuilder

Methods inherited from interface com.google.protobuf. MessageLite

Field Detail

NULL_VALUE_FIELD_NUMBER

NUMBER_VALUE_FIELD_NUMBER

STRING_VALUE_FIELD_NUMBER

BOOL_VALUE_FIELD_NUMBER

STRUCT_VALUE_FIELD_NUMBER

LIST_VALUE_FIELD_NUMBER

Method Detail

getUnknownFields

getDescriptor

getKindCase

hasNullValue

getNullValueValue

getNullValue

hasNumberValue

getNumberValue

hasStringValue

getStringValue

getStringValueBytes

hasBoolValue

getBoolValue

hasStructValue

getStructValue

getStructValueOrBuilder

hasListValue

getListValue

getListValueOrBuilder

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType