public final class Value extends GeneratedMessage implements ValueOrBuilder
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.
Modifier and Type | Class and Description |
---|---|
static class |
Value.Builder
Protobuf type
google.protobuf.Value |
static class |
Value.KindCase |
GeneratedMessage.BuilderParent, 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>
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 Parser<Value> |
PARSER |
static int |
STRING_VALUE_FIELD_NUMBER |
static int |
STRUCT_VALUE_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(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.
|
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.
|
protected GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.
|
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.
|
protected Value.Builder |
newBuilderForType(GeneratedMessage.BuilderParent parent) |
static Value |
parseDelimitedFrom(InputStream input) |
static Value |
parseDelimitedFrom(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(InputStream input) |
static Value |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
Value.Builder |
toBuilder()
Constructs a builder initialized with the current message.
|
void |
writeTo(CodedOutputStream output)
Serializes the message and writes it to
output . |
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField, writeReplace
findInitializationErrors, getInitializationErrorString, hashFields, toString
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int NULL_VALUE_FIELD_NUMBER
public static final int NUMBER_VALUE_FIELD_NUMBER
public static final int STRING_VALUE_FIELD_NUMBER
public static final int BOOL_VALUE_FIELD_NUMBER
public static final int STRUCT_VALUE_FIELD_NUMBER
public static final int LIST_VALUE_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
MessageOrBuilder
UnknownFieldSet
for this message.getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessage
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
GeneratedMessage
internalGetFieldAccessorTable
in class GeneratedMessage
public Value.KindCase getKindCase()
public int getNullValueValue()
optional .google.protobuf.NullValue null_value = 1;
Represents a null value.
getNullValueValue
in interface ValueOrBuilder
public NullValue getNullValue()
optional .google.protobuf.NullValue null_value = 1;
Represents a null value.
getNullValue
in interface ValueOrBuilder
public double getNumberValue()
optional double number_value = 2;
Represents a double value.
getNumberValue
in interface ValueOrBuilder
public String getStringValue()
optional string string_value = 3;
Represents a string value.
getStringValue
in interface ValueOrBuilder
public ByteString getStringValueBytes()
optional string string_value = 3;
Represents a string value.
getStringValueBytes
in interface ValueOrBuilder
public boolean getBoolValue()
optional bool bool_value = 4;
Represents a boolean value.
getBoolValue
in interface ValueOrBuilder
public Struct getStructValue()
optional .google.protobuf.Struct struct_value = 5;
Represents a structured value.
getStructValue
in interface ValueOrBuilder
public StructOrBuilder getStructValueOrBuilder()
optional .google.protobuf.Struct struct_value = 5;
Represents a structured value.
getStructValueOrBuilder
in interface ValueOrBuilder
public ListValue getListValue()
optional .google.protobuf.ListValue list_value = 6;
Represents a repeated `Value`.
getListValue
in interface ValueOrBuilder
public ListValueOrBuilder getListValueOrBuilder()
optional .google.protobuf.ListValue list_value = 6;
Represents a repeated `Value`.
getListValueOrBuilder
in interface ValueOrBuilder
public final boolean isInitialized()
MessageLiteOrBuilder
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessage
public void writeTo(CodedOutputStream output) throws IOException
MessageLite
output
. This does not
flush or close the stream.writeTo
in interface MessageLite
writeTo
in class GeneratedMessage
IOException
public int getSerializedSize()
MessageLite
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessage
public boolean equals(Object obj)
Message
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.equals
in interface Message
equals
in class AbstractMessage
obj
- object to be compared for equality with this messagetrue
if the specified object is equal to this messagepublic int hashCode()
Message
Object.hashCode()
is incorrect.hashCode
in interface Message
hashCode
in class AbstractMessage
Map.hashCode()
public static Value parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Value parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Value parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Value parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Value parseFrom(InputStream input) throws IOException
IOException
public static Value parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Value parseDelimitedFrom(InputStream input) throws IOException
IOException
public static Value parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Value parseFrom(CodedInputStream input) throws IOException
IOException
public static Value parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public Value.Builder newBuilderForType()
MessageLite
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static Value.Builder newBuilder()
public static Value.Builder newBuilder(Value prototype)
public Value.Builder toBuilder()
MessageLite
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected Value.Builder newBuilderForType(GeneratedMessage.BuilderParent parent)
newBuilderForType
in class GeneratedMessage
public static Value getDefaultInstance()
public Parser<Value> getParserForType()
MessageLite
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessage
public Value getDefaultInstanceForType()
MessageLiteOrBuilder
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.getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2008–2015 Google. All rights reserved.