com.google.protobuf

Class Value

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.protobuf.Value

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, ValueOrBuilder, java.io.Serializable

public final class Value
extends GeneratedMessage
implements ValueOrBuilder

Protobuf type google.protobuf.Value

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Value.Builder Protobuf type google.protobuf.Value
static class	Value.KindCase

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

GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>

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

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares the specified object with this message for equality.
boolean	getBoolValue() optional bool bool_value = 4;
static Value	getDefaultInstance()
Value	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Value.KindCase	getKindCase()
ListValue	getListValue() optional .google.protobuf.ListValue list_value = 6;
ListValueOrBuilder	getListValueOrBuilder() optional .google.protobuf.ListValue list_value = 6;
NullValue	getNullValue() optional .google.protobuf.NullValue null_value = 1;
int	getNullValueValue() optional .google.protobuf.NullValue null_value = 1;
double	getNumberValue() optional double number_value = 2;
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() optional string string_value = 3;
ByteString	getStringValueBytes() optional string string_value = 3;
Struct	getStructValue() optional .google.protobuf.Struct struct_value = 5;
StructOrBuilder	getStructValueOrBuilder() optional .google.protobuf.Struct struct_value = 5;
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
int	hashCode() Returns the hash code value for this message.
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(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.GeneratedMessage

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension

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 UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessage

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

getKindCase

public Value.KindCase getKindCase()

Specified by:

getKindCase in interface ValueOrBuilder

getNullValueValue

public int getNullValueValue()

optional .google.protobuf.NullValue null_value = 1;

 Represents a null value.
 

Specified by:

getNullValueValue in interface ValueOrBuilder

getNullValue

public NullValue getNullValue()

optional .google.protobuf.NullValue null_value = 1;

 Represents a null value.
 

Specified by:

getNullValue in interface ValueOrBuilder

getNumberValue

public double getNumberValue()

optional double number_value = 2;

 Represents a double value.
 

Specified by:

getNumberValue in interface ValueOrBuilder

getStringValue

public java.lang.String getStringValue()

optional string string_value = 3;

 Represents a string value.
 

Specified by:

getStringValue in interface ValueOrBuilder

getStringValueBytes

public ByteString getStringValueBytes()

optional string string_value = 3;

 Represents a string value.
 

Specified by:

getStringValueBytes in interface ValueOrBuilder

getBoolValue

public boolean getBoolValue()

optional bool bool_value = 4;

 Represents a boolean value.
 

Specified by:

getBoolValue in interface ValueOrBuilder

getStructValue

public Struct getStructValue()

optional .google.protobuf.Struct struct_value = 5;

 Represents a structured value.
 

Specified by:

getStructValue in interface ValueOrBuilder

getStructValueOrBuilder

public StructOrBuilder getStructValueOrBuilder()

optional .google.protobuf.Struct struct_value = 5;

 Represents a structured value.
 

Specified by:

getStructValueOrBuilder in interface ValueOrBuilder

getListValue

public ListValue getListValue()

optional .google.protobuf.ListValue list_value = 6;

 Represents a repeated `Value`.
 

Specified by:

getListValue in interface ValueOrBuilder

getListValueOrBuilder

public ListValueOrBuilder getListValueOrBuilder()

optional .google.protobuf.ListValue list_value = 6;

 Represents a repeated `Value`.
 

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 GeneratedMessage

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 GeneratedMessage

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 GeneratedMessage

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(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 GeneratedMessage

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