Class FieldInfo.Builder (2.48.0)

public static final class FieldInfo.Builder extends GeneratedMessageV3.Builder<FieldInfo.Builder> implements FieldInfoOrBuilder

Rich semantic information of an API field beyond basic typing.

Protobuf type google.api.FieldInfo

Implements

FieldInfoOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllReferencedTypes(Iterable<? extends TypeReference> values)

public FieldInfo.Builder addAllReferencedTypes(Iterable<? extends TypeReference> values)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameter
Name Description
values Iterable<? extends com.google.api.TypeReference>
Returns
Type Description
FieldInfo.Builder

addReferencedTypes(TypeReference value)

public FieldInfo.Builder addReferencedTypes(TypeReference value)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameter
Name Description
value TypeReference
Returns
Type Description
FieldInfo.Builder

addReferencedTypes(TypeReference.Builder builderForValue)

public FieldInfo.Builder addReferencedTypes(TypeReference.Builder builderForValue)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameter
Name Description
builderForValue TypeReference.Builder
Returns
Type Description
FieldInfo.Builder

addReferencedTypes(int index, TypeReference value)

public FieldInfo.Builder addReferencedTypes(int index, TypeReference value)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameters
Name Description
index int
value TypeReference
Returns
Type Description
FieldInfo.Builder

addReferencedTypes(int index, TypeReference.Builder builderForValue)

public FieldInfo.Builder addReferencedTypes(int index, TypeReference.Builder builderForValue)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameters
Name Description
index int
builderForValue TypeReference.Builder
Returns
Type Description
FieldInfo.Builder

addReferencedTypesBuilder()

public TypeReference.Builder addReferencedTypesBuilder()

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Returns
Type Description
TypeReference.Builder

addReferencedTypesBuilder(int index)

public TypeReference.Builder addReferencedTypesBuilder(int index)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameter
Name Description
index int
Returns
Type Description
TypeReference.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FieldInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FieldInfo.Builder
Overrides

build()

public FieldInfo build()
Returns
Type Description
FieldInfo

buildPartial()

public FieldInfo buildPartial()
Returns
Type Description
FieldInfo

clear()

public FieldInfo.Builder clear()
Returns
Type Description
FieldInfo.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public FieldInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FieldInfo.Builder
Overrides

clearFormat()

public FieldInfo.Builder clearFormat()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FieldInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FieldInfo.Builder
Overrides

clearReferencedTypes()

public FieldInfo.Builder clearReferencedTypes()

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Returns
Type Description
FieldInfo.Builder

clone()

public FieldInfo.Builder clone()
Returns
Type Description
FieldInfo.Builder
Overrides

getDefaultInstanceForType()

public FieldInfo getDefaultInstanceForType()
Returns
Type Description
FieldInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getReferencedTypes(int index)

public TypeReference getReferencedTypes(int index)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameter
Name Description
index int
Returns
Type Description
TypeReference

getReferencedTypesBuilder(int index)

public TypeReference.Builder getReferencedTypesBuilder(int index)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameter
Name Description
index int
Returns
Type Description
TypeReference.Builder

getReferencedTypesBuilderList()

public List<TypeReference.Builder> getReferencedTypesBuilderList()

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Returns
Type Description
List<Builder>

getReferencedTypesCount()

public int getReferencedTypesCount()

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Returns
Type Description
int

getReferencedTypesList()

public List<TypeReference> getReferencedTypesList()

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Returns
Type Description
List<TypeReference>

getReferencedTypesOrBuilder(int index)

public TypeReferenceOrBuilder getReferencedTypesOrBuilder(int index)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameter
Name Description
index int
Returns
Type Description
TypeReferenceOrBuilder

getReferencedTypesOrBuilderList()

public List<? extends TypeReferenceOrBuilder> getReferencedTypesOrBuilderList()

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Returns
Type Description
List<? extends com.google.api.TypeReferenceOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FieldInfo other)

public FieldInfo.Builder mergeFrom(FieldInfo other)
Parameter
Name Description
other FieldInfo
Returns
Type Description
FieldInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FieldInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FieldInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FieldInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FieldInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FieldInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FieldInfo.Builder
Overrides

removeReferencedTypes(int index)

public FieldInfo.Builder removeReferencedTypes(int index)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameter
Name Description
index int
Returns
Type Description
FieldInfo.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FieldInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FieldInfo.Builder
Overrides

setFormat(FieldInfo.Format value)

public FieldInfo.Builder setFormat(FieldInfo.Format value)

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;

Parameter
Name Description
value FieldInfo.Format

The format to set.

Returns
Type Description
FieldInfo.Builder

This builder for chaining.

setFormatValue(int value)

public FieldInfo.Builder setFormatValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for format to set.

Returns
Type Description
FieldInfo.Builder

This builder for chaining.

setReferencedTypes(int index, TypeReference value)

public FieldInfo.Builder setReferencedTypes(int index, TypeReference value)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameters
Name Description
index int
value TypeReference
Returns
Type Description
FieldInfo.Builder

setReferencedTypes(int index, TypeReference.Builder builderForValue)

public FieldInfo.Builder setReferencedTypes(int index, TypeReference.Builder builderForValue)

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

repeated .google.api.TypeReference referenced_types = 2;

Parameters
Name Description
index int
builderForValue TypeReference.Builder
Returns
Type Description
FieldInfo.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FieldInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FieldInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FieldInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FieldInfo.Builder
Overrides