Openapiv2.Operation.Builder (pinecone-java-client 0.2.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>
    - - grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Operation.Builder

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

Enclosing class:: Openapiv2.Operation

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Openapiv2.Operation.Builder`	`addAllConsumes(java.lang.Iterable<java.lang.String> values)` A list of MIME types the operation can consume.
`Openapiv2.Operation.Builder`	`addAllProduces(java.lang.Iterable<java.lang.String> values)` A list of MIME types the operation can produce.
`Openapiv2.Operation.Builder`	`addAllSchemes(java.lang.Iterable<? extends Openapiv2.Scheme> values)` The transfer protocol for the operation.
`Openapiv2.Operation.Builder`	`addAllSchemesValue(java.lang.Iterable<java.lang.Integer> values)` The transfer protocol for the operation.
`Openapiv2.Operation.Builder`	`addAllSecurity(java.lang.Iterable<? extends Openapiv2.SecurityRequirement> values)` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`addAllTags(java.lang.Iterable<java.lang.String> values)` A list of tags for API documentation control.
`Openapiv2.Operation.Builder`	`addConsumes(java.lang.String value)` A list of MIME types the operation can consume.
`Openapiv2.Operation.Builder`	`addConsumesBytes(com.google.protobuf.ByteString value)` A list of MIME types the operation can consume.
`Openapiv2.Operation.Builder`	`addProduces(java.lang.String value)` A list of MIME types the operation can produce.
`Openapiv2.Operation.Builder`	`addProducesBytes(com.google.protobuf.ByteString value)` A list of MIME types the operation can produce.
`Openapiv2.Operation.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`Openapiv2.Operation.Builder`	`addSchemes(Openapiv2.Scheme value)` The transfer protocol for the operation.
`Openapiv2.Operation.Builder`	`addSchemesValue(int value)` The transfer protocol for the operation.
`Openapiv2.Operation.Builder`	`addSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`addSecurity(int index, Openapiv2.SecurityRequirement value)` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`addSecurity(Openapiv2.SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`addSecurity(Openapiv2.SecurityRequirement value)` A declaration of which security schemes are applied for this operation.
`Openapiv2.SecurityRequirement.Builder`	`addSecurityBuilder()` A declaration of which security schemes are applied for this operation.
`Openapiv2.SecurityRequirement.Builder`	`addSecurityBuilder(int index)` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`addTags(java.lang.String value)` A list of tags for API documentation control.
`Openapiv2.Operation.Builder`	`addTagsBytes(com.google.protobuf.ByteString value)` A list of tags for API documentation control.
`Openapiv2.Operation`	`build()`
`Openapiv2.Operation`	`buildPartial()`
`Openapiv2.Operation.Builder`	`clear()`
`Openapiv2.Operation.Builder`	`clearConsumes()` A list of MIME types the operation can consume.
`Openapiv2.Operation.Builder`	`clearDeprecated()` Declares this operation to be deprecated.
`Openapiv2.Operation.Builder`	`clearDescription()` A verbose explanation of the operation behavior.
`Openapiv2.Operation.Builder`	`clearExtensions()`
`Openapiv2.Operation.Builder`	`clearExternalDocs()` Additional external documentation for this operation.
`Openapiv2.Operation.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Openapiv2.Operation.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Openapiv2.Operation.Builder`	`clearOperationId()` Unique string used to identify the operation.
`Openapiv2.Operation.Builder`	`clearProduces()` A list of MIME types the operation can produce.
`Openapiv2.Operation.Builder`	`clearResponses()`
`Openapiv2.Operation.Builder`	`clearSchemes()` The transfer protocol for the operation.
`Openapiv2.Operation.Builder`	`clearSecurity()` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`clearSummary()` A short summary of what the operation does.
`Openapiv2.Operation.Builder`	`clearTags()` A list of tags for API documentation control.
`Openapiv2.Operation.Builder`	`clone()`
`boolean`	`containsExtensions(java.lang.String key)` `map<string, .google.protobuf.Value> extensions = 13;`
`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.
`Openapiv2.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()` `map<string, .google.protobuf.Value> extensions = 13;`
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensionsMap()` `map<string, .google.protobuf.Value> extensions = 13;`
`com.google.protobuf.Value`	`getExtensionsOrDefault(java.lang.String key, com.google.protobuf.Value defaultValue)` `map<string, .google.protobuf.Value> extensions = 13;`
`com.google.protobuf.Value`	`getExtensionsOrThrow(java.lang.String key)` `map<string, .google.protobuf.Value> extensions = 13;`
`Openapiv2.ExternalDocumentation`	`getExternalDocs()` Additional external documentation for this operation.
`Openapiv2.ExternalDocumentation.Builder`	`getExternalDocsBuilder()` Additional external documentation for this operation.
`Openapiv2.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,Openapiv2.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.
`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,Openapiv2.Response>`	`getResponses()` Deprecated.
`int`	`getResponsesCount()` The list of possible responses as they are returned from executing this operation.
`java.util.Map<java.lang.String,Openapiv2.Response>`	`getResponsesMap()` The list of possible responses as they are returned from executing this operation.
`Openapiv2.Response`	`getResponsesOrDefault(java.lang.String key, Openapiv2.Response defaultValue)` The list of possible responses as they are returned from executing this operation.
`Openapiv2.Response`	`getResponsesOrThrow(java.lang.String key)` The list of possible responses as they are returned from executing this operation.
`Openapiv2.Scheme`	`getSchemes(int index)` The transfer protocol for the operation.
`int`	`getSchemesCount()` The transfer protocol for the operation.
`java.util.List<Openapiv2.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.
`Openapiv2.SecurityRequirement`	`getSecurity(int index)` A declaration of which security schemes are applied for this operation.
`Openapiv2.SecurityRequirement.Builder`	`getSecurityBuilder(int index)` A declaration of which security schemes are applied for this operation.
`java.util.List<Openapiv2.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<Openapiv2.SecurityRequirement>`	`getSecurityList()` A declaration of which security schemes are applied for this operation.
`Openapiv2.SecurityRequirementOrBuilder`	`getSecurityOrBuilder(int index)` A declaration of which security schemes are applied for this operation.
`java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder>`	`getSecurityOrBuilderList()` A declaration of which security schemes are applied for this operation.
`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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`Openapiv2.Operation.Builder`	`mergeExternalDocs(Openapiv2.ExternalDocumentation value)` Additional external documentation for this operation.
`Openapiv2.Operation.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Openapiv2.Operation.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Openapiv2.Operation.Builder`	`mergeFrom(Openapiv2.Operation other)`
`Openapiv2.Operation.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Openapiv2.Operation.Builder`	`putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)` `map<string, .google.protobuf.Value> extensions = 13;`
`Openapiv2.Operation.Builder`	`putAllResponses(java.util.Map<java.lang.String,Openapiv2.Response> values)` The list of possible responses as they are returned from executing this operation.
`Openapiv2.Operation.Builder`	`putExtensions(java.lang.String key, com.google.protobuf.Value value)` `map<string, .google.protobuf.Value> extensions = 13;`
`Openapiv2.Operation.Builder`	`putResponses(java.lang.String key, Openapiv2.Response value)` The list of possible responses as they are returned from executing this operation.
`Openapiv2.Operation.Builder`	`removeExtensions(java.lang.String key)` `map<string, .google.protobuf.Value> extensions = 13;`
`Openapiv2.Operation.Builder`	`removeResponses(java.lang.String key)` The list of possible responses as they are returned from executing this operation.
`Openapiv2.Operation.Builder`	`removeSecurity(int index)` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`setConsumes(int index, java.lang.String value)` A list of MIME types the operation can consume.
`Openapiv2.Operation.Builder`	`setDeprecated(boolean value)` Declares this operation to be deprecated.
`Openapiv2.Operation.Builder`	`setDescription(java.lang.String value)` A verbose explanation of the operation behavior.
`Openapiv2.Operation.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` A verbose explanation of the operation behavior.
`Openapiv2.Operation.Builder`	`setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)` Additional external documentation for this operation.
`Openapiv2.Operation.Builder`	`setExternalDocs(Openapiv2.ExternalDocumentation value)` Additional external documentation for this operation.
`Openapiv2.Operation.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`Openapiv2.Operation.Builder`	`setOperationId(java.lang.String value)` Unique string used to identify the operation.
`Openapiv2.Operation.Builder`	`setOperationIdBytes(com.google.protobuf.ByteString value)` Unique string used to identify the operation.
`Openapiv2.Operation.Builder`	`setProduces(int index, java.lang.String value)` A list of MIME types the operation can produce.
`Openapiv2.Operation.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`Openapiv2.Operation.Builder`	`setSchemes(int index, Openapiv2.Scheme value)` The transfer protocol for the operation.
`Openapiv2.Operation.Builder`	`setSchemesValue(int index, int value)` The transfer protocol for the operation.
`Openapiv2.Operation.Builder`	`setSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`setSecurity(int index, Openapiv2.SecurityRequirement value)` A declaration of which security schemes are applied for this operation.
`Openapiv2.Operation.Builder`	`setSummary(java.lang.String value)` A short summary of what the operation does.
`Openapiv2.Operation.Builder`	`setSummaryBytes(com.google.protobuf.ByteString value)` A short summary of what the operation does.
`Openapiv2.Operation.Builder`	`setTags(int index, java.lang.String value)` A list of tags for API documentation control.
`Openapiv2.Operation.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, 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.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

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

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

internalGetMutableMapField
```
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
```
Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

clear
```
public Openapiv2.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.GeneratedMessageV3.Builder<Openapiv2.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.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

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

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

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

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

Specified by:

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

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

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

Specified by:

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

clone
```
public Openapiv2.Operation.Builder clone()
```
Specified by:

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

Specified by:

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

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

setField
```
public Openapiv2.Operation.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            java.lang.Object value)
```
Specified by:

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

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

clearField
```
public Openapiv2.Operation.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

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

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

clearOneof
```
public Openapiv2.Operation.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

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

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

setRepeatedField

public Openapiv2.Operation.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    java.lang.Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

addRepeatedField
```
public Openapiv2.Operation.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    java.lang.Object value)
```
Specified by:

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

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

mergeFrom
```
public Openapiv2.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<Openapiv2.Operation.Builder>

mergeFrom

public Openapiv2.Operation.Builder mergeFrom(Openapiv2.Operation other)

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

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

mergeFrom
```
public Openapiv2.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<Openapiv2.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;

Specified by:: getTagsList in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Returns:: The count of tags.

getTags

public java.lang.String getTags(int index)

 A list of tags for API documentation control. Tags can be used for logical
 grouping of operations by resources or any other qualifier.

repeated string tags = 1;

Specified by:: getTags in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the tags at the given index.

setTags

public Openapiv2.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;

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

addTags

public Openapiv2.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;

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

addAllTags

public Openapiv2.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;

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

clearTags

public Openapiv2.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;

Returns:: This builder for chaining.

addTagsBytes

public Openapiv2.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;

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;

Specified by:: getSummary in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Returns:: The bytes for summary.

setSummary

public Openapiv2.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;

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

clearSummary

public Openapiv2.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;

Returns:: This builder for chaining.

setSummaryBytes

public Openapiv2.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;

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;

Specified by:: getDescription in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Returns:: The bytes for description.

setDescription

public Openapiv2.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;

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

clearDescription

public Openapiv2.Operation.Builder clearDescription()

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

string description = 3;

Returns:: This builder for chaining.

setDescriptionBytes

public Openapiv2.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;

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;
Specified by:

hasExternalDocs in interface Openapiv2.OperationOrBuilder

Returns:

Whether the externalDocs field is set.

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

getExternalDocs in interface Openapiv2.OperationOrBuilder

Returns:

The externalDocs.

setExternalDocs

public Openapiv2.Operation.Builder setExternalDocs(Openapiv2.ExternalDocumentation value)

 Additional external documentation for this operation.

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;

setExternalDocs

public Openapiv2.Operation.Builder setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)

 Additional external documentation for this operation.

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;

mergeExternalDocs

public Openapiv2.Operation.Builder mergeExternalDocs(Openapiv2.ExternalDocumentation value)

 Additional external documentation for this operation.

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;

clearExternalDocs

public Openapiv2.Operation.Builder clearExternalDocs()

 Additional external documentation for this operation.

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;

getExternalDocsBuilder

public Openapiv2.ExternalDocumentation.Builder getExternalDocsBuilder()

 Additional external documentation for this operation.

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;

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

getExternalDocsOrBuilder in interface Openapiv2.OperationOrBuilder

getOperationId

public java.lang.String getOperationId()

 Unique string used to identify the operation. The id MUST be unique among
 all operations described in the API. Tools and libraries MAY use the
 operationId to uniquely identify an operation, therefore, it is recommended
 to follow common programming naming conventions.

string operation_id = 5;

Specified by:: getOperationId in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Returns:: The bytes for operationId.

setOperationId

public Openapiv2.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;

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

clearOperationId

public Openapiv2.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;

Returns:: This builder for chaining.

setOperationIdBytes

public Openapiv2.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;

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;

Specified by:: getConsumesList in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Returns:: The count of consumes.

getConsumes

public java.lang.String getConsumes(int index)

 A list of MIME types the operation can consume. This overrides the consumes
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.

repeated string consumes = 6;

Specified by:: getConsumes in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the consumes at the given index.

setConsumes

public Openapiv2.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;

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

addConsumes

public Openapiv2.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;

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

addAllConsumes

public Openapiv2.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;

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

clearConsumes

public Openapiv2.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;

Returns:: This builder for chaining.

addConsumesBytes

public Openapiv2.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;

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;

Specified by:: getProducesList in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Returns:: The count of produces.

getProduces

public java.lang.String getProduces(int index)

 A list of MIME types the operation can produce. This overrides the produces
 definition at the OpenAPI Object. An empty value MAY be used to clear the
 global definition. Value MUST be as described under Mime Types.

repeated string produces = 7;

Specified by:: getProduces in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the produces at the given index.

setProduces

public Openapiv2.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;

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

addProduces

public Openapiv2.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;

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

addAllProduces

public Openapiv2.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;

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

clearProduces

public Openapiv2.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;

Returns:: This builder for chaining.

addProducesBytes

public Openapiv2.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;

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

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 interface Openapiv2.OperationOrBuilder

containsResponses
```
public boolean containsResponses(java.lang.String key)
```
```
 The list of possible responses as they are returned from executing this
 operation.
 
```
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;
Specified by:

containsResponses in interface Openapiv2.OperationOrBuilder

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

Use getResponsesMap() instead.

Specified by:

getResponses in interface Openapiv2.OperationOrBuilder

getResponsesMap

public java.util.Map<java.lang.String,Openapiv2.Response> getResponsesMap()

 The list of possible responses as they are returned from executing this
 operation.

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;

Specified by:: getResponsesMap in interface Openapiv2.OperationOrBuilder

getResponsesOrDefault

public Openapiv2.Response getResponsesOrDefault(java.lang.String key,
                                                Openapiv2.Response defaultValue)

 The list of possible responses as they are returned from executing this
 operation.

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;

Specified by:: getResponsesOrDefault in interface Openapiv2.OperationOrBuilder

getResponsesOrThrow
```
public Openapiv2.Response getResponsesOrThrow(java.lang.String key)
```
```
 The list of possible responses as they are returned from executing this
 operation.
 
```
map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;
Specified by:

getResponsesOrThrow in interface Openapiv2.OperationOrBuilder

clearResponses

public Openapiv2.Operation.Builder clearResponses()

removeResponses

public Openapiv2.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;

getMutableResponses

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

Deprecated.

Use alternate mutation accessors instead.

putResponses

public Openapiv2.Operation.Builder putResponses(java.lang.String key,
                                                Openapiv2.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;

putAllResponses

public Openapiv2.Operation.Builder putAllResponses(java.util.Map<java.lang.String,Openapiv2.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;

getSchemesList

public java.util.List<Openapiv2.Scheme> getSchemesList()

 The transfer protocol for the operation. Values MUST be from the list:
 "http", "https", "ws", "wss". The value overrides the OpenAPI Object
 schemes definition.

repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;

Specified by:: getSchemesList in interface Openapiv2.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 interface Openapiv2.OperationOrBuilder
Returns:: The count of schemes.

getSchemes
```
public Openapiv2.Scheme getSchemes(int index)
```
```
 The transfer protocol for the operation. Values MUST be from the list:
 "http", "https", "ws", "wss". The value overrides the OpenAPI Object
 schemes definition.
 
```
repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;
Specified by:

getSchemes in interface Openapiv2.OperationOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The schemes at the given index.

setSchemes

public Openapiv2.Operation.Builder setSchemes(int index,
                                              Openapiv2.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;

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

addSchemes

public Openapiv2.Operation.Builder addSchemes(Openapiv2.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;

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

addAllSchemes

public Openapiv2.Operation.Builder addAllSchemes(java.lang.Iterable<? extends Openapiv2.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;

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

clearSchemes

public Openapiv2.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;

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;
Specified by:

getSchemesValueList in interface Openapiv2.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 interface Openapiv2.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 Openapiv2.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;

Parameters:: index - The index of the value to return.
Returns:: The enum numeric value on the wire of schemes at the given index.

addSchemesValue

public Openapiv2.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;

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

addAllSchemesValue

public Openapiv2.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;

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;

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

setDeprecated

public Openapiv2.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;

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

clearDeprecated

public Openapiv2.Operation.Builder clearDeprecated()

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

bool deprecated = 11;

Returns:: This builder for chaining.