Class Openapiv2.Operation
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Operation
-
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Openapiv2.OperationOrBuilder,java.io.Serializable
- Enclosing class:
- Openapiv2
public static final class Openapiv2.Operation extends com.google.protobuf.GeneratedMessageV3 implements Openapiv2.OperationOrBuilder
`Operation` is a representation of OpenAPI v2 specification's Operation object. See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject Example: service EchoService { rpc Echo(SimpleMessage) returns (SimpleMessage) { option (google.api.http) = { get: "/v1/example/echo/{id}" }; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { summary: "Get a message."; operation_id: "getMessage"; tags: "echo"; responses: { key: "200" value: { description: "OK"; } } }; } }Protobuf typegrpc.gateway.protoc_gen_openapiv2.options.Operation- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOpenapiv2.Operation.Builder`Operation` is a representation of OpenAPI v2 specification's Operation object.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intCONSUMES_FIELD_NUMBERstatic intDEPRECATED_FIELD_NUMBERstatic intDESCRIPTION_FIELD_NUMBERstatic intEXTENSIONS_FIELD_NUMBERstatic intEXTERNAL_DOCS_FIELD_NUMBERstatic intOPERATION_ID_FIELD_NUMBERstatic intPARAMETERS_FIELD_NUMBERstatic intPRODUCES_FIELD_NUMBERstatic intRESPONSES_FIELD_NUMBERstatic intSCHEMES_FIELD_NUMBERstatic intSECURITY_FIELD_NUMBERstatic intSUMMARY_FIELD_NUMBERstatic intTAGS_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsExtensions(java.lang.String key)Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.booleancontainsResponses(java.lang.String key)The list of possible responses as they are returned from executing this operation.booleanequals(java.lang.Object obj)java.lang.StringgetConsumes(int index)A list of MIME types the operation can consume.com.google.protobuf.ByteStringgetConsumesBytes(int index)A list of MIME types the operation can consume.intgetConsumesCount()A list of MIME types the operation can consume.com.google.protobuf.ProtocolStringListgetConsumesList()A list of MIME types the operation can consume.static Openapiv2.OperationgetDefaultInstance()Openapiv2.OperationgetDefaultInstanceForType()booleangetDeprecated()Declares this operation to be deprecated.java.lang.StringgetDescription()A verbose explanation of the operation behavior.com.google.protobuf.ByteStringgetDescriptionBytes()A verbose explanation of the operation behavior.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()java.util.Map<java.lang.String,com.google.protobuf.Value>getExtensions()Deprecated.intgetExtensionsCount()Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.java.util.Map<java.lang.String,com.google.protobuf.Value>getExtensionsMap()Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.com.google.protobuf.ValuegetExtensionsOrDefault(java.lang.String key, com.google.protobuf.Value defaultValue)Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.com.google.protobuf.ValuegetExtensionsOrThrow(java.lang.String key)Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.Openapiv2.ExternalDocumentationgetExternalDocs()Additional external documentation for this operation.Openapiv2.ExternalDocumentationOrBuildergetExternalDocsOrBuilder()Additional external documentation for this operation.java.lang.StringgetOperationId()Unique string used to identify the operation.com.google.protobuf.ByteStringgetOperationIdBytes()Unique string used to identify the operation.Openapiv2.ParametersgetParameters()Custom parameters such as HTTP request headers.Openapiv2.ParametersOrBuildergetParametersOrBuilder()Custom parameters such as HTTP request headers.com.google.protobuf.Parser<Openapiv2.Operation>getParserForType()java.lang.StringgetProduces(int index)A list of MIME types the operation can produce.com.google.protobuf.ByteStringgetProducesBytes(int index)A list of MIME types the operation can produce.intgetProducesCount()A list of MIME types the operation can produce.com.google.protobuf.ProtocolStringListgetProducesList()A list of MIME types the operation can produce.java.util.Map<java.lang.String,Openapiv2.Response>getResponses()Deprecated.intgetResponsesCount()The list of possible responses as they are returned from executing this operation.java.util.Map<java.lang.String,Openapiv2.Response>getResponsesMap()The list of possible responses as they are returned from executing this operation.Openapiv2.ResponsegetResponsesOrDefault(java.lang.String key, Openapiv2.Response defaultValue)The list of possible responses as they are returned from executing this operation.Openapiv2.ResponsegetResponsesOrThrow(java.lang.String key)The list of possible responses as they are returned from executing this operation.Openapiv2.SchemegetSchemes(int index)The transfer protocol for the operation.intgetSchemesCount()The transfer protocol for the operation.java.util.List<Openapiv2.Scheme>getSchemesList()The transfer protocol for the operation.intgetSchemesValue(int index)The transfer protocol for the operation.java.util.List<java.lang.Integer>getSchemesValueList()The transfer protocol for the operation.Openapiv2.SecurityRequirementgetSecurity(int index)A declaration of which security schemes are applied for this operation.intgetSecurityCount()A declaration of which security schemes are applied for this operation.java.util.List<Openapiv2.SecurityRequirement>getSecurityList()A declaration of which security schemes are applied for this operation.Openapiv2.SecurityRequirementOrBuildergetSecurityOrBuilder(int index)A declaration of which security schemes are applied for this operation.java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder>getSecurityOrBuilderList()A declaration of which security schemes are applied for this operation.intgetSerializedSize()java.lang.StringgetSummary()A short summary of what the operation does.com.google.protobuf.ByteStringgetSummaryBytes()A short summary of what the operation does.java.lang.StringgetTags(int index)A list of tags for API documentation control.com.google.protobuf.ByteStringgetTagsBytes(int index)A list of tags for API documentation control.intgetTagsCount()A list of tags for API documentation control.com.google.protobuf.ProtocolStringListgetTagsList()A list of tags for API documentation control.booleanhasExternalDocs()Additional external documentation for this operation.inthashCode()booleanhasParameters()Custom parameters such as HTTP request headers.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number)booleanisInitialized()static Openapiv2.Operation.BuildernewBuilder()static Openapiv2.Operation.BuildernewBuilder(Openapiv2.Operation prototype)Openapiv2.Operation.BuildernewBuilderForType()protected Openapiv2.Operation.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected java.lang.ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static Openapiv2.OperationparseDelimitedFrom(java.io.InputStream input)static Openapiv2.OperationparseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.OperationparseFrom(byte[] data)static Openapiv2.OperationparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.OperationparseFrom(com.google.protobuf.ByteString data)static Openapiv2.OperationparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.OperationparseFrom(com.google.protobuf.CodedInputStream input)static Openapiv2.OperationparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.OperationparseFrom(java.io.InputStream input)static Openapiv2.OperationparseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Openapiv2.OperationparseFrom(java.nio.ByteBuffer data)static Openapiv2.OperationparseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Openapiv2.Operation>parser()Openapiv2.Operation.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SUMMARY_FIELD_NUMBER
public static final int SUMMARY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
EXTERNAL_DOCS_FIELD_NUMBER
public static final int EXTERNAL_DOCS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
OPERATION_ID_FIELD_NUMBER
public static final int OPERATION_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONSUMES_FIELD_NUMBER
public static final int CONSUMES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PRODUCES_FIELD_NUMBER
public static final int PRODUCES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RESPONSES_FIELD_NUMBER
public static final int RESPONSES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SCHEMES_FIELD_NUMBER
public static final int SCHEMES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DEPRECATED_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SECURITY_FIELD_NUMBER
public static final int SECURITY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
EXTENSIONS_FIELD_NUMBER
public static final int EXTENSIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
- Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getTagsList
public com.google.protobuf.ProtocolStringList getTagsList()
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated string tags = 1;- Specified by:
getTagsListin interfaceOpenapiv2.OperationOrBuilder- Returns:
- A list containing the tags.
-
getTagsCount
public int getTagsCount()
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated string tags = 1;- Specified by:
getTagsCountin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The count of tags.
-
getTags
public java.lang.String getTags(int index)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated string tags = 1;- Specified by:
getTagsin interfaceOpenapiv2.OperationOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The tags at the given index.
-
getTagsBytes
public com.google.protobuf.ByteString getTagsBytes(int index)
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
repeated string tags = 1;- Specified by:
getTagsBytesin interfaceOpenapiv2.OperationOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the tags at the given index.
-
getSummary
public java.lang.String getSummary()
A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
string summary = 2;- Specified by:
getSummaryin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The summary.
-
getSummaryBytes
public com.google.protobuf.ByteString getSummaryBytes()
A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
string summary = 2;- Specified by:
getSummaryBytesin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The bytes for summary.
-
getDescription
public java.lang.String getDescription()
A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.
string description = 3;- Specified by:
getDescriptionin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.
string description = 3;- Specified by:
getDescriptionBytesin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The bytes for description.
-
hasExternalDocs
public boolean hasExternalDocs()
Additional external documentation for this operation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;- Specified by:
hasExternalDocsin interfaceOpenapiv2.OperationOrBuilder- Returns:
- Whether the externalDocs field is set.
-
getExternalDocs
public Openapiv2.ExternalDocumentation getExternalDocs()
Additional external documentation for this operation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;- Specified by:
getExternalDocsin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The externalDocs.
-
getExternalDocsOrBuilder
public Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
Additional external documentation for this operation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;- Specified by:
getExternalDocsOrBuilderin interfaceOpenapiv2.OperationOrBuilder
-
getOperationId
public java.lang.String getOperationId()
Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
string operation_id = 5;- Specified by:
getOperationIdin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The operationId.
-
getOperationIdBytes
public com.google.protobuf.ByteString getOperationIdBytes()
Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
string operation_id = 5;- Specified by:
getOperationIdBytesin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The bytes for operationId.
-
getConsumesList
public com.google.protobuf.ProtocolStringList getConsumesList()
A list of MIME types the operation can consume. This overrides the consumes definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Specified by:
getConsumesListin interfaceOpenapiv2.OperationOrBuilder- Returns:
- A list containing the consumes.
-
getConsumesCount
public int getConsumesCount()
A list of MIME types the operation can consume. This overrides the consumes definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Specified by:
getConsumesCountin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The count of consumes.
-
getConsumes
public java.lang.String getConsumes(int index)
A list of MIME types the operation can consume. This overrides the consumes definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Specified by:
getConsumesin interfaceOpenapiv2.OperationOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The consumes at the given index.
-
getConsumesBytes
public com.google.protobuf.ByteString getConsumesBytes(int index)
A list of MIME types the operation can consume. This overrides the consumes definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
repeated string consumes = 6;- Specified by:
getConsumesBytesin interfaceOpenapiv2.OperationOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the consumes at the given index.
-
getProducesList
public com.google.protobuf.ProtocolStringList getProducesList()
A list of MIME types the operation can produce. This overrides the produces definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
repeated string produces = 7;- Specified by:
getProducesListin interfaceOpenapiv2.OperationOrBuilder- Returns:
- A list containing the produces.
-
getProducesCount
public int getProducesCount()
A list of MIME types the operation can produce. This overrides the produces definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
repeated string produces = 7;- Specified by:
getProducesCountin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The count of produces.
-
getProduces
public java.lang.String getProduces(int index)
A list of MIME types the operation can produce. This overrides the produces definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
repeated string produces = 7;- Specified by:
getProducesin interfaceOpenapiv2.OperationOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The produces at the given index.
-
getProducesBytes
public com.google.protobuf.ByteString getProducesBytes(int index)
A list of MIME types the operation can produce. This overrides the produces definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
repeated string produces = 7;- Specified by:
getProducesBytesin interfaceOpenapiv2.OperationOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the produces at the given index.
-
getResponsesCount
public int getResponsesCount()
Description copied from interface:Openapiv2.OperationOrBuilderThe list of possible responses as they are returned from executing this operation.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;- Specified by:
getResponsesCountin interfaceOpenapiv2.OperationOrBuilder
-
containsResponses
public boolean containsResponses(java.lang.String key)
The list of possible responses as they are returned from executing this operation.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;- Specified by:
containsResponsesin interfaceOpenapiv2.OperationOrBuilder
-
getResponses
@Deprecated public java.util.Map<java.lang.String,Openapiv2.Response> getResponses()
Deprecated.UsegetResponsesMap()instead.- Specified by:
getResponsesin interfaceOpenapiv2.OperationOrBuilder
-
getResponsesMap
public java.util.Map<java.lang.String,Openapiv2.Response> getResponsesMap()
The list of possible responses as they are returned from executing this operation.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;- Specified by:
getResponsesMapin interfaceOpenapiv2.OperationOrBuilder
-
getResponsesOrDefault
public Openapiv2.Response getResponsesOrDefault(java.lang.String key, Openapiv2.Response defaultValue)
The list of possible responses as they are returned from executing this operation.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;- Specified by:
getResponsesOrDefaultin interfaceOpenapiv2.OperationOrBuilder
-
getResponsesOrThrow
public Openapiv2.Response getResponsesOrThrow(java.lang.String key)
The list of possible responses as they are returned from executing this operation.
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;- Specified by:
getResponsesOrThrowin interfaceOpenapiv2.OperationOrBuilder
-
getSchemesList
public java.util.List<Openapiv2.Scheme> getSchemesList()
The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the OpenAPI Object schemes definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;- Specified by:
getSchemesListin interfaceOpenapiv2.OperationOrBuilder- Returns:
- A list containing the schemes.
-
getSchemesCount
public int getSchemesCount()
The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the OpenAPI Object schemes definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;- Specified by:
getSchemesCountin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The count of schemes.
-
getSchemes
public Openapiv2.Scheme getSchemes(int index)
The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the OpenAPI Object schemes definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;- Specified by:
getSchemesin interfaceOpenapiv2.OperationOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The schemes at the given index.
-
getSchemesValueList
public java.util.List<java.lang.Integer> getSchemesValueList()
The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the OpenAPI Object schemes definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;- Specified by:
getSchemesValueListin interfaceOpenapiv2.OperationOrBuilder- Returns:
- A list containing the enum numeric values on the wire for schemes.
-
getSchemesValue
public int getSchemesValue(int index)
The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the OpenAPI Object schemes definition.
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;- Specified by:
getSchemesValuein interfaceOpenapiv2.OperationOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of schemes at the given index.
-
getDeprecated
public boolean getDeprecated()
Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.
bool deprecated = 11;- Specified by:
getDeprecatedin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The deprecated.
-
getSecurityList
public java.util.List<Openapiv2.SecurityRequirement> getSecurityList()
A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityListin interfaceOpenapiv2.OperationOrBuilder
-
getSecurityOrBuilderList
public java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder> getSecurityOrBuilderList()
A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityOrBuilderListin interfaceOpenapiv2.OperationOrBuilder
-
getSecurityCount
public int getSecurityCount()
A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityCountin interfaceOpenapiv2.OperationOrBuilder
-
getSecurity
public Openapiv2.SecurityRequirement getSecurity(int index)
A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityin interfaceOpenapiv2.OperationOrBuilder
-
getSecurityOrBuilder
public Openapiv2.SecurityRequirementOrBuilder getSecurityOrBuilder(int index)
A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;- Specified by:
getSecurityOrBuilderin interfaceOpenapiv2.OperationOrBuilder
-
getExtensionsCount
public int getExtensionsCount()
Description copied from interface:Openapiv2.OperationOrBuilderCustom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/
map<string, .google.protobuf.Value> extensions = 13;- Specified by:
getExtensionsCountin interfaceOpenapiv2.OperationOrBuilder
-
containsExtensions
public boolean containsExtensions(java.lang.String key)
Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/
map<string, .google.protobuf.Value> extensions = 13;- Specified by:
containsExtensionsin interfaceOpenapiv2.OperationOrBuilder
-
getExtensions
@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()
Deprecated.UsegetExtensionsMap()instead.- Specified by:
getExtensionsin interfaceOpenapiv2.OperationOrBuilder
-
getExtensionsMap
public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensionsMap()
Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/
map<string, .google.protobuf.Value> extensions = 13;- Specified by:
getExtensionsMapin interfaceOpenapiv2.OperationOrBuilder
-
getExtensionsOrDefault
public com.google.protobuf.Value getExtensionsOrDefault(java.lang.String key, com.google.protobuf.Value defaultValue)Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/
map<string, .google.protobuf.Value> extensions = 13;- Specified by:
getExtensionsOrDefaultin interfaceOpenapiv2.OperationOrBuilder
-
getExtensionsOrThrow
public com.google.protobuf.Value getExtensionsOrThrow(java.lang.String key)
Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/
map<string, .google.protobuf.Value> extensions = 13;- Specified by:
getExtensionsOrThrowin interfaceOpenapiv2.OperationOrBuilder
-
hasParameters
public boolean hasParameters()
Custom parameters such as HTTP request headers. See: https://swagger.io/docs/specification/2-0/describing-parameters/ and https://swagger.io/specification/v2/#parameter-object.
.grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;- Specified by:
hasParametersin interfaceOpenapiv2.OperationOrBuilder- Returns:
- Whether the parameters field is set.
-
getParameters
public Openapiv2.Parameters getParameters()
Custom parameters such as HTTP request headers. See: https://swagger.io/docs/specification/2-0/describing-parameters/ and https://swagger.io/specification/v2/#parameter-object.
.grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;- Specified by:
getParametersin interfaceOpenapiv2.OperationOrBuilder- Returns:
- The parameters.
-
getParametersOrBuilder
public Openapiv2.ParametersOrBuilder getParametersOrBuilder()
Custom parameters such as HTTP request headers. See: https://swagger.io/docs/specification/2-0/describing-parameters/ and https://swagger.io/specification/v2/#parameter-object.
.grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;- Specified by:
getParametersOrBuilderin interfaceOpenapiv2.OperationOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Openapiv2.Operation parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Operation parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Operation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Operation 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.Operation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Operation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Operation parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Openapiv2.Operation parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Openapiv2.Operation parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Openapiv2.Operation parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Openapiv2.Operation parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Openapiv2.Operation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Openapiv2.Operation.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Openapiv2.Operation.Builder newBuilder()
-
newBuilder
public static Openapiv2.Operation.Builder newBuilder(Openapiv2.Operation prototype)
-
toBuilder
public Openapiv2.Operation.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Openapiv2.Operation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Openapiv2.Operation getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Openapiv2.Operation> parser()
-
getParserForType
public com.google.protobuf.Parser<Openapiv2.Operation> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Openapiv2.Operation getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-