Class Openapiv2.Operation
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
,Serializable
- Enclosing class:
- Openapiv2
public static final class Openapiv2.Operation
extends com.google.protobuf.GeneratedMessage
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 type
grpc.gateway.protoc_gen_openapiv2.options.Operation
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
`Operation` is a representation of OpenAPI v2 specification's Operation object.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
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
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 TypeMethodDescriptionboolean
containsExtensions
(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.boolean
containsResponses
(String key) The list of possible responses as they are returned from executing this operation.boolean
getConsumes
(int index) A list of MIME types the operation can consume.com.google.protobuf.ByteString
getConsumesBytes
(int index) A list of MIME types the operation can consume.int
A list of MIME types the operation can consume.com.google.protobuf.ProtocolStringList
A list of MIME types the operation can consume.static Openapiv2.Operation
boolean
Declares this operation to be deprecated.A verbose explanation of the operation behavior.com.google.protobuf.ByteString
A verbose explanation of the operation behavior.static final com.google.protobuf.Descriptors.Descriptor
Deprecated.int
Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.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.Value
getExtensionsOrDefault
(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.Value
Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.Additional external documentation for this operation.Additional external documentation for this operation.Unique string used to identify the operation.com.google.protobuf.ByteString
Unique string used to identify the operation.Custom parameters such as HTTP request headers.Custom parameters such as HTTP request headers.com.google.protobuf.Parser<Openapiv2.Operation>
getProduces
(int index) A list of MIME types the operation can produce.com.google.protobuf.ByteString
getProducesBytes
(int index) A list of MIME types the operation can produce.int
A list of MIME types the operation can produce.com.google.protobuf.ProtocolStringList
A list of MIME types the operation can produce.Deprecated.int
The list of possible responses as they are returned from executing this operation.The list of possible responses as they are returned from executing this operation.getResponsesOrDefault
(String key, Openapiv2.Response defaultValue) The list of possible responses as they are returned from executing this operation.The list of possible responses as they are returned from executing this operation.getSchemes
(int index) The transfer protocol for the operation.int
The transfer protocol for the operation.The transfer protocol for the operation.int
getSchemesValue
(int index) The transfer protocol for the operation.The transfer protocol for the operation.getSecurity
(int index) A declaration of which security schemes are applied for this operation.int
A declaration of which security schemes are applied for this operation.A declaration of which security schemes are applied for this operation.getSecurityOrBuilder
(int index) A declaration of which security schemes are applied for this operation.List<? extends Openapiv2.SecurityRequirementOrBuilder>
A declaration of which security schemes are applied for this operation.int
A short summary of what the operation does.com.google.protobuf.ByteString
A short summary of what the operation does.getTags
(int index) A list of tags for API documentation control.com.google.protobuf.ByteString
getTagsBytes
(int index) A list of tags for API documentation control.int
A list of tags for API documentation control.com.google.protobuf.ProtocolStringList
A list of tags for API documentation control.boolean
Additional external documentation for this operation.int
hashCode()
boolean
Custom parameters such as HTTP request headers.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMapFieldReflection
(int number) final boolean
static Openapiv2.Operation.Builder
static Openapiv2.Operation.Builder
newBuilder
(Openapiv2.Operation prototype) protected Openapiv2.Operation.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static Openapiv2.Operation
parseDelimitedFrom
(InputStream input) static Openapiv2.Operation
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.Operation
parseFrom
(byte[] data) static Openapiv2.Operation
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.Operation
parseFrom
(com.google.protobuf.ByteString data) static Openapiv2.Operation
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.Operation
parseFrom
(com.google.protobuf.CodedInputStream input) static Openapiv2.Operation
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.Operation
parseFrom
(InputStream input) static Openapiv2.Operation
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.Operation
parseFrom
(ByteBuffer data) static Openapiv2.Operation
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Openapiv2.Operation>
parser()
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, 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
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER- See Also:
-
SUMMARY_FIELD_NUMBER
public static final int SUMMARY_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
EXTERNAL_DOCS_FIELD_NUMBER
public static final int EXTERNAL_DOCS_FIELD_NUMBER- See Also:
-
OPERATION_ID_FIELD_NUMBER
public static final int OPERATION_ID_FIELD_NUMBER- See Also:
-
CONSUMES_FIELD_NUMBER
public static final int CONSUMES_FIELD_NUMBER- See Also:
-
PRODUCES_FIELD_NUMBER
public static final int PRODUCES_FIELD_NUMBER- See Also:
-
RESPONSES_FIELD_NUMBER
public static final int RESPONSES_FIELD_NUMBER- See Also:
-
SCHEMES_FIELD_NUMBER
public static final int SCHEMES_FIELD_NUMBER- See Also:
-
DEPRECATED_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER- See Also:
-
SECURITY_FIELD_NUMBER
public static final int SECURITY_FIELD_NUMBER- See Also:
-
EXTENSIONS_FIELD_NUMBER
public static final int EXTENSIONS_FIELD_NUMBER- See Also:
-
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflection
in classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
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:
getTagsList
in 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:
getTagsCount
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- The count of tags.
-
getTags
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:
getTags
in 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:
getTagsBytes
in interfaceOpenapiv2.OperationOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the tags at the given index.
-
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:
getSummary
in 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:
getSummaryBytes
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- The bytes for summary.
-
getDescription
A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.
string description = 3;
- Specified by:
getDescription
in 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:
getDescriptionBytes
in 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:
hasExternalDocs
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- Whether the externalDocs field is set.
-
getExternalDocs
Additional external documentation for this operation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;
- Specified by:
getExternalDocs
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- The externalDocs.
-
getExternalDocsOrBuilder
Additional external documentation for this operation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;
- Specified by:
getExternalDocsOrBuilder
in interfaceOpenapiv2.OperationOrBuilder
-
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:
getOperationId
in 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:
getOperationIdBytes
in 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:
getConsumesList
in 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:
getConsumesCount
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- The count of consumes.
-
getConsumes
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:
getConsumes
in 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:
getConsumesBytes
in 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:
getProducesList
in 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:
getProducesCount
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- The count of produces.
-
getProduces
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:
getProduces
in 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:
getProducesBytes
in 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.OperationOrBuilder
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:
getResponsesCount
in interfaceOpenapiv2.OperationOrBuilder
-
containsResponses
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:
containsResponses
in interfaceOpenapiv2.OperationOrBuilder
-
getResponses
Deprecated.UsegetResponsesMap()
instead.- Specified by:
getResponses
in interfaceOpenapiv2.OperationOrBuilder
-
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:
getResponsesMap
in interfaceOpenapiv2.OperationOrBuilder
-
getResponsesOrDefault
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:
getResponsesOrDefault
in interfaceOpenapiv2.OperationOrBuilder
-
getResponsesOrThrow
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:
getResponsesOrThrow
in interfaceOpenapiv2.OperationOrBuilder
-
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:
getSchemesList
in 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:
getSchemesCount
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- The count of schemes.
-
getSchemes
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:
getSchemes
in interfaceOpenapiv2.OperationOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The schemes at the given index.
-
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:
getSchemesValueList
in 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:
getSchemesValue
in 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:
getDeprecated
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- The deprecated.
-
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:
getSecurityList
in interfaceOpenapiv2.OperationOrBuilder
-
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:
getSecurityOrBuilderList
in 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:
getSecurityCount
in interfaceOpenapiv2.OperationOrBuilder
-
getSecurity
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:
getSecurity
in interfaceOpenapiv2.OperationOrBuilder
-
getSecurityOrBuilder
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:
getSecurityOrBuilder
in interfaceOpenapiv2.OperationOrBuilder
-
getExtensionsCount
public int getExtensionsCount()Description copied from interface:Openapiv2.OperationOrBuilder
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:
getExtensionsCount
in interfaceOpenapiv2.OperationOrBuilder
-
containsExtensions
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:
containsExtensions
in interfaceOpenapiv2.OperationOrBuilder
-
getExtensions
Deprecated.UsegetExtensionsMap()
instead.- Specified by:
getExtensions
in interfaceOpenapiv2.OperationOrBuilder
-
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:
getExtensionsMap
in interfaceOpenapiv2.OperationOrBuilder
-
getExtensionsOrDefault
public com.google.protobuf.Value getExtensionsOrDefault(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:
getExtensionsOrDefault
in interfaceOpenapiv2.OperationOrBuilder
-
getExtensionsOrThrow
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:
getExtensionsOrThrow
in 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:
hasParameters
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- Whether the parameters field is set.
-
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:
getParameters
in interfaceOpenapiv2.OperationOrBuilder
- Returns:
- The parameters.
-
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:
getParametersOrBuilder
in interfaceOpenapiv2.OperationOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Openapiv2.Operation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Operation parseFrom(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
- Throws:
IOException
-
parseFrom
public static Openapiv2.Operation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Openapiv2.Operation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static Openapiv2.Operation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static Openapiv2.Operation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Openapiv2.Operation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-