Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.JSONSchema.FieldConfiguration

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

All Implemented Interfaces:

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

Enclosing class:

Openapiv2.JSONSchema

public static final class Openapiv2.JSONSchema.FieldConfiguration
extends com.google.protobuf.GeneratedMessage
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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Openapiv2.JSONSchema.FieldConfiguration.Builder	'FieldConfiguration' provides additional field level properties used when generating the OpenAPI v2 file.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PATH_PARAM_NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Openapiv2.JSONSchema.FieldConfiguration	getDefaultInstance()
Openapiv2.JSONSchema.FieldConfiguration	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Openapiv2.JSONSchema.FieldConfiguration>	getParserForType()
String	getPathParamName()	Alternative parameter name when used as path parameter.
com.google.protobuf.ByteString	getPathParamNameBytes()	Alternative parameter name when used as path parameter.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Openapiv2.JSONSchema.FieldConfiguration.Builder	newBuilder()
static Openapiv2.JSONSchema.FieldConfiguration.Builder	newBuilder(Openapiv2.JSONSchema.FieldConfiguration prototype)
Openapiv2.JSONSchema.FieldConfiguration.Builder	newBuilderForType()
protected Openapiv2.JSONSchema.FieldConfiguration.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Openapiv2.JSONSchema.FieldConfiguration	parseDelimitedFrom(InputStream input)
static Openapiv2.JSONSchema.FieldConfiguration	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(byte[] data)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(com.google.protobuf.ByteString data)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(com.google.protobuf.CodedInputStream input)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(InputStream input)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(ByteBuffer data)
static Openapiv2.JSONSchema.FieldConfiguration	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Openapiv2.JSONSchema.FieldConfiguration>	parser()
Openapiv2.JSONSchema.FieldConfiguration.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

PATH_PARAM_NAME_FIELD_NUMBER

public static final int PATH_PARAM_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(com.google.protobuf.ByteString data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(byte[] data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseDelimitedFrom(InputStream input)
                                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws IOException

Throws:

IOException

parseFrom

public static Openapiv2.JSONSchema.FieldConfiguration parseFrom(com.google.protobuf.CodedInputStream input)
                                                         throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Openapiv2.JSONSchema.FieldConfiguration.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Openapiv2.JSONSchema.FieldConfiguration.Builder newBuilder()

newBuilder

public static Openapiv2.JSONSchema.FieldConfiguration.Builder newBuilder(Openapiv2.JSONSchema.FieldConfiguration prototype)

toBuilder

public Openapiv2.JSONSchema.FieldConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Openapiv2.JSONSchema.FieldConfiguration.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Openapiv2.JSONSchema.FieldConfiguration getDefaultInstance()

parser

public static com.google.protobuf.Parser<Openapiv2.JSONSchema.FieldConfiguration> parser()

getParserForType

public com.google.protobuf.Parser<Openapiv2.JSONSchema.FieldConfiguration> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Openapiv2.JSONSchema.FieldConfiguration getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder