Operation (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.grpc.gateway.protoc_gen_openapiv2.options.Operation

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OperationOrBuilder, java.io.Serializable

public final class Operation
extends com.google.protobuf.GeneratedMessage
implements 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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Operation.Builder
`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>, 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`Operation.Builder` `Operation` is a representation of OpenAPI v2 specification's Operation object.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONSUMES_FIELD_NUMBER`
`static int`	`DEPRECATED_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`EXTENSIONS_FIELD_NUMBER`
`static int`	`EXTERNAL_DOCS_FIELD_NUMBER`
`static int`	`OPERATION_ID_FIELD_NUMBER`
`static int`	`PARAMETERS_FIELD_NUMBER`
`static int`	`PRODUCES_FIELD_NUMBER`
`static int`	`RESPONSES_FIELD_NUMBER`
`static int`	`SCHEMES_FIELD_NUMBER`
`static int`	`SECURITY_FIELD_NUMBER`
`static int`	`SUMMARY_FIELD_NUMBER`
`static int`	`TAGS_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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`boolean`	`containsResponses(java.lang.String key)` The list of possible responses as they are returned from executing this operation.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`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`	`getConsumesCount()` A list of MIME types the operation can consume.
`com.google.protobuf.ProtocolStringList`	`getConsumesList()` A list of MIME types the operation can consume.
`static Operation`	`getDefaultInstance()`
`Operation`	`getDefaultInstanceForType()`
`boolean`	`getDeprecated()` Declares this operation to be deprecated.
`java.lang.String`	`getDescription()` A verbose explanation of the operation behavior.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` A verbose explanation of the operation behavior.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensions()` Deprecated.
`int`	`getExtensionsCount()` 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.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.
`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.
`ExternalDocumentation`	`getExternalDocs()` Additional external documentation for this operation.
`ExternalDocumentationOrBuilder`	`getExternalDocsOrBuilder()` Additional external documentation for this operation.
`java.lang.String`	`getOperationId()` Unique string used to identify the operation.
`com.google.protobuf.ByteString`	`getOperationIdBytes()` Unique string used to identify the operation.
`Parameters`	`getParameters()` Custom parameters such as HTTP request headers.
`ParametersOrBuilder`	`getParametersOrBuilder()` Custom parameters such as HTTP request headers.
`com.google.protobuf.Parser<Operation>`	`getParserForType()`
`java.lang.String`	`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`	`getProducesCount()` A list of MIME types the operation can produce.
`com.google.protobuf.ProtocolStringList`	`getProducesList()` A list of MIME types the operation can produce.
`java.util.Map<java.lang.String,Response>`	`getResponses()` Deprecated.
`int`	`getResponsesCount()` The list of possible responses as they are returned from executing this operation.
`java.util.Map<java.lang.String,Response>`	`getResponsesMap()` The list of possible responses as they are returned from executing this operation.
`Response`	`getResponsesOrDefault(java.lang.String key, Response defaultValue)` The list of possible responses as they are returned from executing this operation.
`Response`	`getResponsesOrThrow(java.lang.String key)` The list of possible responses as they are returned from executing this operation.
`Scheme`	`getSchemes(int index)` The transfer protocol for the operation.
`int`	`getSchemesCount()` The transfer protocol for the operation.
`java.util.List<Scheme>`	`getSchemesList()` The transfer protocol for the operation.
`int`	`getSchemesValue(int index)` The transfer protocol for the operation.
`java.util.List<java.lang.Integer>`	`getSchemesValueList()` The transfer protocol for the operation.
`SecurityRequirement`	`getSecurity(int index)` A declaration of which security schemes are applied for this operation.
`int`	`getSecurityCount()` A declaration of which security schemes are applied for this operation.
`java.util.List<SecurityRequirement>`	`getSecurityList()` A declaration of which security schemes are applied for this operation.
`SecurityRequirementOrBuilder`	`getSecurityOrBuilder(int index)` A declaration of which security schemes are applied for this operation.
`java.util.List<? extends SecurityRequirementOrBuilder>`	`getSecurityOrBuilderList()` A declaration of which security schemes are applied for this operation.
`int`	`getSerializedSize()`
`java.lang.String`	`getSummary()` A short summary of what the operation does.
`com.google.protobuf.ByteString`	`getSummaryBytes()` A short summary of what the operation does.
`java.lang.String`	`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`	`getTagsCount()` A list of tags for API documentation control.
`com.google.protobuf.ProtocolStringList`	`getTagsList()` A list of tags for API documentation control.
`boolean`	`hasExternalDocs()` Additional external documentation for this operation.
`int`	`hashCode()`
`boolean`	`hasParameters()` Custom parameters such as HTTP request headers.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static Operation.Builder`	`newBuilder()`
`static Operation.Builder`	`newBuilder(Operation prototype)`
`Operation.Builder`	`newBuilderForType()`
`protected Operation.Builder`	`newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)`
`static Operation`	`parseDelimitedFrom(java.io.InputStream input)`
`static Operation`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Operation`	`parseFrom(byte[] data)`
`static Operation`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Operation`	`parseFrom(java.nio.ByteBuffer data)`
`static Operation`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Operation`	`parseFrom(com.google.protobuf.ByteString data)`
`static Operation`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Operation`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Operation`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Operation`	`parseFrom(java.io.InputStream input)`
`static Operation`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Operation>`	`parser()`
`Operation.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, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

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

getDescriptor

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

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.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 [json_name = "tags"];

Specified by:: getTagsList in interface 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 [json_name = "tags"];

Specified by:: getTagsCount in interface 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 [json_name = "tags"];
Specified by:

getTags in interface 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 [json_name = "tags"];
Specified by:

getTagsBytes in interface 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 [json_name = "summary"];

Specified by:: getSummary in interface 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 [json_name = "summary"];

Specified by:: getSummaryBytes in interface 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 [json_name = "description"];

Specified by:: getDescription in interface 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 [json_name = "description"];

Specified by:: getDescriptionBytes in interface 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 [json_name = "externalDocs"];
Specified by:

hasExternalDocs in interface OperationOrBuilder

Returns:

Whether the externalDocs field is set.

getExternalDocs
```
public ExternalDocumentation getExternalDocs()
```
```
 Additional external documentation for this operation.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4 [json_name = "externalDocs"];
Specified by:

getExternalDocs in interface OperationOrBuilder

Returns:

The externalDocs.

getExternalDocsOrBuilder
```
public ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
```
```
 Additional external documentation for this operation.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4 [json_name = "externalDocs"];
Specified by:

getExternalDocsOrBuilder in interface 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 [json_name = "operationId"];

Specified by:: getOperationId in interface 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 [json_name = "operationId"];

Specified by:: getOperationIdBytes in interface 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 [json_name = "consumes"];

Specified by:: getConsumesList in interface 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 [json_name = "consumes"];

Specified by:: getConsumesCount in interface 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 [json_name = "consumes"];

Specified by:: getConsumes in interface 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 [json_name = "consumes"];

Specified by:: getConsumesBytes in interface 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 [json_name = "produces"];

Specified by:: getProducesList in interface 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 [json_name = "produces"];

Specified by:: getProducesCount in interface 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 [json_name = "produces"];

Specified by:: getProduces in interface 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 [json_name = "produces"];

Specified by:: getProducesBytes in interface 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: 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 [json_name = "responses"];
Specified by:

getResponsesCount in interface 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 [json_name = "responses"];
Specified by:

containsResponses in interface OperationOrBuilder

getResponses
```
@Deprecated
public java.util.Map<java.lang.String,Response> getResponses()
```
Deprecated.

Use getResponsesMap() instead.

Specified by:

getResponses in interface OperationOrBuilder

getResponsesMap
```
public java.util.Map<java.lang.String,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 [json_name = "responses"];
Specified by:

getResponsesMap in interface OperationOrBuilder

getResponsesOrDefault

public Response getResponsesOrDefault(java.lang.String key,
                                      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 [json_name = "responses"];

Specified by:: getResponsesOrDefault in interface OperationOrBuilder

getResponsesOrThrow
```
public 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 [json_name = "responses"];
Specified by:

getResponsesOrThrow in interface OperationOrBuilder

getSchemesList

public java.util.List<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 [json_name = "schemes"];

Specified by:: getSchemesList in interface 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 [json_name = "schemes"];
Specified by:

getSchemesCount in interface OperationOrBuilder

Returns:

The count of schemes.

getSchemes
```
public 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 [json_name = "schemes"];
Specified by:

getSchemes in interface 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 [json_name = "schemes"];
Specified by:

getSchemesValueList in interface 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 [json_name = "schemes"];
Specified by:

getSchemesValue in interface 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 [json_name = "deprecated"];

Specified by:: getDeprecated in interface OperationOrBuilder
Returns:: The deprecated.

getSecurityList

public java.util.List<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 [json_name = "security"];

Specified by:: getSecurityList in interface OperationOrBuilder

getSecurityOrBuilderList

public java.util.List<? extends 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 [json_name = "security"];

Specified by:: getSecurityOrBuilderList in interface 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 [json_name = "security"];

Specified by:: getSecurityCount in interface OperationOrBuilder

getSecurity

public 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 [json_name = "security"];

Specified by:: getSecurity in interface OperationOrBuilder

getSecurityOrBuilder

public 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 [json_name = "security"];

Specified by:: getSecurityOrBuilder in interface OperationOrBuilder