Class FieldInfo (2.38.0)

public final class FieldInfo extends GeneratedMessageV3 implements FieldInfoOrBuilder

Rich semantic information of an API field beyond basic typing.

Protobuf type google.api.FieldInfo

Implements

FieldInfoOrBuilder

Static Fields

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FieldInfo getDefaultInstance()
Returns
Type Description
FieldInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FieldInfo.Builder newBuilder()
Returns
Type Description
FieldInfo.Builder

newBuilder(FieldInfo prototype)

public static FieldInfo.Builder newBuilder(FieldInfo prototype)
Parameter
Name Description
prototype FieldInfo
Returns
Type Description
FieldInfo.Builder

parseDelimitedFrom(InputStream input)

public static FieldInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FieldInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FieldInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FieldInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FieldInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FieldInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FieldInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FieldInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FieldInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FieldInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FieldInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FieldInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FieldInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FieldInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FieldInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FieldInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FieldInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FieldInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FieldInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FieldInfo> parser()
Returns
Type Description
Parser<FieldInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public FieldInfo getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for format.

getParserForType()

public Parser<FieldInfo> getParserForType()
Returns
Type Description
Parser<FieldInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FieldInfo.Builder newBuilderForType()
Returns
Type Description
FieldInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FieldInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FieldInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FieldInfo.Builder toBuilder()
Returns
Type Description
FieldInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException