Class Openapiv2.JSONSchema.FieldConfiguration.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.JSONSchema.FieldConfiguration.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.JSONSchema.FieldConfigurationOrBuilder, Cloneable

Enclosing class:

Openapiv2.JSONSchema.FieldConfiguration

public static final class Openapiv2.JSONSchema.FieldConfiguration.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>
implements Openapiv2.JSONSchema.FieldConfigurationOrBuilder

 'FieldConfiguration' provides additional field level properties used when generating the OpenAPI v2 file.
 These properties are not defined by OpenAPIv2, but they are used to control the generation.
 

Protobuf type grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration

Method Summary

Modifier and Type	Method	Description
Openapiv2.JSONSchema.FieldConfiguration.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Openapiv2.JSONSchema.FieldConfiguration	build()
Openapiv2.JSONSchema.FieldConfiguration	buildPartial()
Openapiv2.JSONSchema.FieldConfiguration.Builder	clear()
Openapiv2.JSONSchema.FieldConfiguration.Builder	clearDeprecated()	Declares this field to be deprecated.
Openapiv2.JSONSchema.FieldConfiguration.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Openapiv2.JSONSchema.FieldConfiguration.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Openapiv2.JSONSchema.FieldConfiguration.Builder	clearPathParamName()	Alternative parameter name when used as path parameter.
Openapiv2.JSONSchema.FieldConfiguration.Builder	clone()
Openapiv2.JSONSchema.FieldConfiguration	getDefaultInstanceForType()
boolean	getDeprecated()	Declares this field to be deprecated.
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getPathParamName()	Alternative parameter name when used as path parameter.
com.google.protobuf.ByteString	getPathParamNameBytes()	Alternative parameter name when used as path parameter.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
Openapiv2.JSONSchema.FieldConfiguration.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Openapiv2.JSONSchema.FieldConfiguration.Builder	mergeFrom(com.google.protobuf.Message other)
Openapiv2.JSONSchema.FieldConfiguration.Builder	mergeFrom(Openapiv2.JSONSchema.FieldConfiguration other)
final Openapiv2.JSONSchema.FieldConfiguration.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Openapiv2.JSONSchema.FieldConfiguration.Builder	setDeprecated(boolean value)	Declares this field to be deprecated.
Openapiv2.JSONSchema.FieldConfiguration.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Openapiv2.JSONSchema.FieldConfiguration.Builder	setPathParamName(String value)	Alternative parameter name when used as path parameter.
Openapiv2.JSONSchema.FieldConfiguration.Builder	setPathParamNameBytes(com.google.protobuf.ByteString value)	Alternative parameter name when used as path parameter.
Openapiv2.JSONSchema.FieldConfiguration.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
final Openapiv2.JSONSchema.FieldConfiguration.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

clear

public Openapiv2.JSONSchema.FieldConfiguration.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

getDefaultInstanceForType

public Openapiv2.JSONSchema.FieldConfiguration getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Openapiv2.JSONSchema.FieldConfiguration build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Openapiv2.JSONSchema.FieldConfiguration buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Openapiv2.JSONSchema.FieldConfiguration.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

setField

public Openapiv2.JSONSchema.FieldConfiguration.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

clearField

public Openapiv2.JSONSchema.FieldConfiguration.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

clearOneof

public Openapiv2.JSONSchema.FieldConfiguration.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

setRepeatedField

public Openapiv2.JSONSchema.FieldConfiguration.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 int index,
 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

addRepeatedField

public Openapiv2.JSONSchema.FieldConfiguration.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

mergeFrom

public Openapiv2.JSONSchema.FieldConfiguration.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

mergeFrom

public Openapiv2.JSONSchema.FieldConfiguration.Builder mergeFrom(Openapiv2.JSONSchema.FieldConfiguration other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

mergeFrom

public Openapiv2.JSONSchema.FieldConfiguration.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                          throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

Throws:

IOException

getPathParamName

public String getPathParamName()

 Alternative parameter name when used as path parameter. If set, this will
 be used as the complete parameter name when this field is used as a path
 parameter. Use this to avoid having auto generated path parameter names
 for overlapping paths.
 

string path_param_name = 47;

Specified by:

getPathParamName in interface Openapiv2.JSONSchema.FieldConfigurationOrBuilder

Returns:

The pathParamName.

getPathParamNameBytes

public com.google.protobuf.ByteString getPathParamNameBytes()

 Alternative parameter name when used as path parameter. If set, this will
 be used as the complete parameter name when this field is used as a path
 parameter. Use this to avoid having auto generated path parameter names
 for overlapping paths.
 

string path_param_name = 47;

Specified by:

getPathParamNameBytes in interface Openapiv2.JSONSchema.FieldConfigurationOrBuilder

Returns:

The bytes for pathParamName.

setPathParamName

public Openapiv2.JSONSchema.FieldConfiguration.Builder setPathParamName(String value)

 Alternative parameter name when used as path parameter. If set, this will
 be used as the complete parameter name when this field is used as a path
 parameter. Use this to avoid having auto generated path parameter names
 for overlapping paths.
 

string path_param_name = 47;

Parameters:

value - The pathParamName to set.

Returns:

This builder for chaining.

clearPathParamName

public Openapiv2.JSONSchema.FieldConfiguration.Builder clearPathParamName()

 Alternative parameter name when used as path parameter. If set, this will
 be used as the complete parameter name when this field is used as a path
 parameter. Use this to avoid having auto generated path parameter names
 for overlapping paths.
 

string path_param_name = 47;

Returns:

This builder for chaining.

setPathParamNameBytes

public Openapiv2.JSONSchema.FieldConfiguration.Builder setPathParamNameBytes(com.google.protobuf.ByteString value)

 Alternative parameter name when used as path parameter. If set, this will
 be used as the complete parameter name when this field is used as a path
 parameter. Use this to avoid having auto generated path parameter names
 for overlapping paths.
 

string path_param_name = 47;

Parameters:

value - The bytes for pathParamName to set.

Returns:

This builder for chaining.

getDeprecated

public boolean getDeprecated()

 Declares this field to be deprecated. Allows for the generated OpenAPI
 parameter to be marked as deprecated without affecting the proto field.
 

bool deprecated = 49;

Specified by:

getDeprecated in interface Openapiv2.JSONSchema.FieldConfigurationOrBuilder

Returns:

The deprecated.

setDeprecated

public Openapiv2.JSONSchema.FieldConfiguration.Builder setDeprecated(boolean value)

 Declares this field to be deprecated. Allows for the generated OpenAPI
 parameter to be marked as deprecated without affecting the proto field.
 

bool deprecated = 49;

Parameters:

value - The deprecated to set.

Returns:

This builder for chaining.

clearDeprecated

public Openapiv2.JSONSchema.FieldConfiguration.Builder clearDeprecated()

 Declares this field to be deprecated. Allows for the generated OpenAPI
 parameter to be marked as deprecated without affecting the proto field.
 

bool deprecated = 49;

Returns:

This builder for chaining.

setUnknownFields

public final Openapiv2.JSONSchema.FieldConfiguration.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>

mergeUnknownFields

public final Openapiv2.JSONSchema.FieldConfiguration.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.JSONSchema.FieldConfiguration.Builder>