Class FieldInfo (2.34.0)

See more code actions.
public final class FieldInfo extends GeneratedMessageV3 implements FieldInfoOrBuilder

Rich semantic information of an API field beyond basic typing.

Protobuf type google.api.FieldInfo

FieldInfoOrBuilder
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FieldInfo getDefaultInstance()
Returns
TypeDescription
FieldInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FieldInfo.Builder newBuilder()
Returns
TypeDescription
FieldInfo.Builder

newBuilder(FieldInfo prototype)

public static FieldInfo.Builder newBuilder(FieldInfo prototype)
Parameter
NameDescription
prototypeFieldInfo
Returns
TypeDescription
FieldInfo.Builder

parseDelimitedFrom(InputStream input)

public static FieldInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FieldInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FieldInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FieldInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FieldInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FieldInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FieldInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FieldInfo> parser()
Returns
TypeDescription
Parser<FieldInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public FieldInfo getDefaultInstanceForType()
Returns
TypeDescription
FieldInfo

getFormat()

public FieldInfo.Format getFormat()

The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to.

.google.api.FieldInfo.Format format = 1;

Returns
TypeDescription
FieldInfo.Format

The format.

getFormatValue()

public int getFormatValue()

The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to.

.google.api.FieldInfo.Format format = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for format.

getParserForType()

public Parser<FieldInfo> getParserForType()
Returns
TypeDescription
Parser<FieldInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FieldInfo.Builder newBuilderForType()
Returns
TypeDescription
FieldInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FieldInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FieldInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FieldInfo.Builder toBuilder()
Returns
TypeDescription
FieldInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException