Operation.Builder (nakama-java 2.5.0 API)

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

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OperationOrBuilder, java.lang.Cloneable

Enclosing class:: Operation

public static final class Operation.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Operation.Builder>
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Operation.Builder`	`addAllConsumes(java.lang.Iterable<java.lang.String> values)` A list of MIME types the operation can consume.
`Operation.Builder`	`addAllProduces(java.lang.Iterable<java.lang.String> values)` A list of MIME types the operation can produce.
`Operation.Builder`	`addAllSchemes(java.lang.Iterable<? extends Scheme> values)` The transfer protocol for the operation.
`Operation.Builder`	`addAllSchemesValue(java.lang.Iterable<java.lang.Integer> values)` The transfer protocol for the operation.
`Operation.Builder`	`addAllSecurity(java.lang.Iterable<? extends SecurityRequirement> values)` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`addAllTags(java.lang.Iterable<java.lang.String> values)` A list of tags for API documentation control.
`Operation.Builder`	`addConsumes(java.lang.String value)` A list of MIME types the operation can consume.
`Operation.Builder`	`addConsumesBytes(com.google.protobuf.ByteString value)` A list of MIME types the operation can consume.
`Operation.Builder`	`addProduces(java.lang.String value)` A list of MIME types the operation can produce.
`Operation.Builder`	`addProducesBytes(com.google.protobuf.ByteString value)` A list of MIME types the operation can produce.
`Operation.Builder`	`addSchemes(Scheme value)` The transfer protocol for the operation.
`Operation.Builder`	`addSchemesValue(int value)` The transfer protocol for the operation.
`Operation.Builder`	`addSecurity(int index, SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`addSecurity(int index, SecurityRequirement value)` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`addSecurity(SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`addSecurity(SecurityRequirement value)` A declaration of which security schemes are applied for this operation.
`SecurityRequirement.Builder`	`addSecurityBuilder()` A declaration of which security schemes are applied for this operation.
`SecurityRequirement.Builder`	`addSecurityBuilder(int index)` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`addTags(java.lang.String value)` A list of tags for API documentation control.
`Operation.Builder`	`addTagsBytes(com.google.protobuf.ByteString value)` A list of tags for API documentation control.
`Operation`	`build()`
`Operation`	`buildPartial()`
`Operation.Builder`	`clear()`
`Operation.Builder`	`clearConsumes()` A list of MIME types the operation can consume.
`Operation.Builder`	`clearDeprecated()` Declares this operation to be deprecated.
`Operation.Builder`	`clearDescription()` A verbose explanation of the operation behavior.
`Operation.Builder`	`clearExtensions()`
`Operation.Builder`	`clearExternalDocs()` Additional external documentation for this operation.
`Operation.Builder`	`clearOperationId()` Unique string used to identify the operation.
`Operation.Builder`	`clearParameters()` Custom parameters such as HTTP request headers.
`Operation.Builder`	`clearProduces()` A list of MIME types the operation can produce.
`Operation.Builder`	`clearResponses()`
`Operation.Builder`	`clearSchemes()` The transfer protocol for the operation.
`Operation.Builder`	`clearSecurity()` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`clearSummary()` A short summary of what the operation does.
`Operation.Builder`	`clearTags()` A list of tags for API documentation control.
`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.
`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.
`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()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`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.
`ExternalDocumentation.Builder`	`getExternalDocsBuilder()` Additional external documentation for this operation.
`ExternalDocumentationOrBuilder`	`getExternalDocsOrBuilder()` Additional external documentation for this operation.
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getMutableExtensions()` Deprecated.
`java.util.Map<java.lang.String,Response>`	`getMutableResponses()` Deprecated.
`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.
`Parameters.Builder`	`getParametersBuilder()` Custom parameters such as HTTP request headers.
`ParametersOrBuilder`	`getParametersOrBuilder()` Custom parameters such as HTTP request headers.
`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.
`SecurityRequirement.Builder`	`getSecurityBuilder(int index)` A declaration of which security schemes are applied for this operation.
`java.util.List<SecurityRequirement.Builder>`	`getSecurityBuilderList()` 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.
`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.
`boolean`	`hasParameters()` Custom parameters such as HTTP request headers.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMutableMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`Operation.Builder`	`mergeExternalDocs(ExternalDocumentation value)` Additional external documentation for this operation.
`Operation.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Operation.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Operation.Builder`	`mergeFrom(Operation other)`
`Operation.Builder`	`mergeParameters(Parameters value)` Custom parameters such as HTTP request headers.
`Operation.Builder`	`putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)` Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`Operation.Builder`	`putAllResponses(java.util.Map<java.lang.String,Response> values)` The list of possible responses as they are returned from executing this operation.
`Operation.Builder`	`putExtensions(java.lang.String key, com.google.protobuf.Value 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.
`com.google.protobuf.Value.Builder`	`putExtensionsBuilderIfAbsent(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.
`Operation.Builder`	`putResponses(java.lang.String key, Response value)` The list of possible responses as they are returned from executing this operation.
`Response.Builder`	`putResponsesBuilderIfAbsent(java.lang.String key)` The list of possible responses as they are returned from executing this operation.
`Operation.Builder`	`removeExtensions(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.
`Operation.Builder`	`removeResponses(java.lang.String key)` The list of possible responses as they are returned from executing this operation.
`Operation.Builder`	`removeSecurity(int index)` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`setConsumes(int index, java.lang.String value)` A list of MIME types the operation can consume.
`Operation.Builder`	`setDeprecated(boolean value)` Declares this operation to be deprecated.
`Operation.Builder`	`setDescription(java.lang.String value)` A verbose explanation of the operation behavior.
`Operation.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` A verbose explanation of the operation behavior.
`Operation.Builder`	`setExternalDocs(ExternalDocumentation.Builder builderForValue)` Additional external documentation for this operation.
`Operation.Builder`	`setExternalDocs(ExternalDocumentation value)` Additional external documentation for this operation.
`Operation.Builder`	`setOperationId(java.lang.String value)` Unique string used to identify the operation.
`Operation.Builder`	`setOperationIdBytes(com.google.protobuf.ByteString value)` Unique string used to identify the operation.
`Operation.Builder`	`setParameters(Parameters.Builder builderForValue)` Custom parameters such as HTTP request headers.
`Operation.Builder`	`setParameters(Parameters value)` Custom parameters such as HTTP request headers.
`Operation.Builder`	`setProduces(int index, java.lang.String value)` A list of MIME types the operation can produce.
`Operation.Builder`	`setSchemes(int index, Scheme value)` The transfer protocol for the operation.
`Operation.Builder`	`setSchemesValue(int index, int value)` The transfer protocol for the operation.
`Operation.Builder`	`setSecurity(int index, SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`setSecurity(int index, SecurityRequirement value)` A declaration of which security schemes are applied for this operation.
`Operation.Builder`	`setSummary(java.lang.String value)` A short summary of what the operation does.
`Operation.Builder`	`setSummaryBytes(com.google.protobuf.ByteString value)` A short summary of what the operation does.
`Operation.Builder`	`setTags(int index, java.lang.String value)` A list of tags for API documentation control.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

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.Builder<Operation.Builder>

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

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Operation.Builder>

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Operation.Builder>

clear
```
public Operation.Builder clear()
```
Specified by:

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

Specified by:

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

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Operation.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

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

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Operation.Builder>

getDefaultInstanceForType
```
public Operation getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Operation build()
```
Specified by:

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

Specified by:

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

buildPartial
```
public Operation buildPartial()
```
Specified by:

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

Specified by:

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

mergeFrom
```
public Operation.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

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

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Operation.Builder>

mergeFrom

public Operation.Builder mergeFrom(Operation other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Operation.Builder>

mergeFrom
```
public Operation.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
```
Specified by:

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

Specified by:

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

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Operation.Builder>

Throws:

java.io.IOException

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.

setTags

public Operation.Builder setTags(int index,
                                 java.lang.String value)

 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"];

Parameters:: index - The index to set the value at.; value - The tags to set.
Returns:: This builder for chaining.

addTags

public Operation.Builder addTags(java.lang.String value)

 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"];

Parameters:: value - The tags to add.
Returns:: This builder for chaining.

addAllTags

public Operation.Builder addAllTags(java.lang.Iterable<java.lang.String> values)

 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"];

Parameters:: values - The tags to add.
Returns:: This builder for chaining.

clearTags

public Operation.Builder clearTags()

 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"];

Returns:: This builder for chaining.

addTagsBytes

public Operation.Builder addTagsBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:: value - The bytes of the tags to add.
Returns:: This builder for chaining.

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.

setSummary

public Operation.Builder setSummary(java.lang.String value)

 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"];

Parameters:: value - The summary to set.
Returns:: This builder for chaining.

clearSummary

public Operation.Builder clearSummary()

 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"];

Returns:: This builder for chaining.

setSummaryBytes

public Operation.Builder setSummaryBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:: value - The bytes for summary to set.
Returns:: This builder for chaining.

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.

setDescription

public Operation.Builder setDescription(java.lang.String value)

 A verbose explanation of the operation behavior. GFM syntax can be used for
 rich text representation.

string description = 3 [json_name = "description"];

Parameters:: value - The description to set.
Returns:: This builder for chaining.

clearDescription

public Operation.Builder clearDescription()

 A verbose explanation of the operation behavior. GFM syntax can be used for
 rich text representation.

string description = 3 [json_name = "description"];

Returns:: This builder for chaining.

setDescriptionBytes

public Operation.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 A verbose explanation of the operation behavior. GFM syntax can be used for
 rich text representation.

string description = 3 [json_name = "description"];

Parameters:: value - The bytes for description to set.
Returns:: This builder for chaining.

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.

setExternalDocs

public Operation.Builder setExternalDocs(ExternalDocumentation value)

 Additional external documentation for this operation.

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4 [json_name = "externalDocs"];

setExternalDocs

public Operation.Builder setExternalDocs(ExternalDocumentation.Builder builderForValue)

 Additional external documentation for this operation.

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4 [json_name = "externalDocs"];

mergeExternalDocs

public Operation.Builder mergeExternalDocs(ExternalDocumentation value)

 Additional external documentation for this operation.

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4 [json_name = "externalDocs"];

clearExternalDocs
```
public Operation.Builder clearExternalDocs()
```
```
 Additional external documentation for this operation.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4 [json_name = "externalDocs"];

getExternalDocsBuilder
```
public ExternalDocumentation.Builder getExternalDocsBuilder()
```
```
 Additional external documentation for this operation.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4 [json_name = "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.

setOperationId

public Operation.Builder setOperationId(java.lang.String value)

 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"];

Parameters:: value - The operationId to set.
Returns:: This builder for chaining.

clearOperationId

public Operation.Builder clearOperationId()

 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"];

Returns:: This builder for chaining.

setOperationIdBytes

public Operation.Builder setOperationIdBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:: value - The bytes for operationId to set.
Returns:: This builder for chaining.

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.

setConsumes

public Operation.Builder setConsumes(int index,
                                     java.lang.String value)

 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"];

Parameters:: index - The index to set the value at.; value - The consumes to set.
Returns:: This builder for chaining.

addConsumes

public Operation.Builder addConsumes(java.lang.String value)

 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"];

Parameters:: value - The consumes to add.
Returns:: This builder for chaining.

addAllConsumes

public Operation.Builder addAllConsumes(java.lang.Iterable<java.lang.String> values)

 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"];

Parameters:: values - The consumes to add.
Returns:: This builder for chaining.

clearConsumes

public Operation.Builder clearConsumes()

 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"];

Returns:: This builder for chaining.

addConsumesBytes

public Operation.Builder addConsumesBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:: value - The bytes of the consumes to add.
Returns:: This builder for chaining.

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.

setProduces

public Operation.Builder setProduces(int index,
                                     java.lang.String value)

 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"];

Parameters:: index - The index to set the value at.; value - The produces to set.
Returns:: This builder for chaining.

addProduces

public Operation.Builder addProduces(java.lang.String value)

 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"];

Parameters:: value - The produces to add.
Returns:: This builder for chaining.

addAllProduces

public Operation.Builder addAllProduces(java.lang.Iterable<java.lang.String> values)

 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"];

Parameters:: values - The produces to add.
Returns:: This builder for chaining.

clearProduces

public Operation.Builder clearProduces()

 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"];

Returns:: This builder for chaining.

addProducesBytes

public Operation.Builder addProducesBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:: value - The bytes of the produces to add.
Returns:: This builder for chaining.

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

clearResponses

public Operation.Builder clearResponses()

removeResponses

public Operation.Builder removeResponses(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"];

getMutableResponses

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

Deprecated.

Use alternate mutation accessors instead.

putResponses

public Operation.Builder putResponses(java.lang.String key,
                                      Response value)

 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"];

putAllResponses

public Operation.Builder putAllResponses(java.util.Map<java.lang.String,Response> values)

 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"];

putResponsesBuilderIfAbsent

public Response.Builder putResponsesBuilderIfAbsent(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"];

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.

setSchemes

public Operation.Builder setSchemes(int index,
                                    Scheme value)

 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"];

Parameters:: index - The index to set the value at.; value - The schemes to set.
Returns:: This builder for chaining.

addSchemes

public Operation.Builder addSchemes(Scheme value)

 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"];

Parameters:: value - The schemes to add.
Returns:: This builder for chaining.

addAllSchemes

public Operation.Builder addAllSchemes(java.lang.Iterable<? extends Scheme> values)

 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"];

Parameters:: values - The schemes to add.
Returns:: This builder for chaining.

clearSchemes

public Operation.Builder clearSchemes()

 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"];

Returns:: This builder for chaining.

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.

setSchemesValue

public Operation.Builder setSchemesValue(int index,
                                         int value)

 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"];

Parameters:: index - The index to set the value at.; value - The enum numeric value on the wire for schemes to set.
Returns:: This builder for chaining.

addSchemesValue

public Operation.Builder addSchemesValue(int value)

 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"];

Parameters:: value - The enum numeric value on the wire for schemes to add.
Returns:: This builder for chaining.

addAllSchemesValue

public Operation.Builder addAllSchemesValue(java.lang.Iterable<java.lang.Integer> values)

 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"];

Parameters:: values - The enum numeric values on the wire for schemes to add.
Returns:: This builder for chaining.

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.

setDeprecated

public Operation.Builder setDeprecated(boolean value)

 Declares this operation to be deprecated. Usage of the declared operation
 should be refrained. Default value is false.

bool deprecated = 11 [json_name = "deprecated"];

Parameters:: value - The deprecated to set.
Returns:: This builder for chaining.

clearDeprecated

public Operation.Builder clearDeprecated()

 Declares this operation to be deprecated. Usage of the declared operation
 should be refrained. Default value is false.

bool deprecated = 11 [json_name = "deprecated"];

Returns:: This builder for chaining.