Package grpc.gateway.protoc_gen_openapiv2.options

Class 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 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>

      • 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.

      • 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;

      • 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.

      • 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

      • 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

      • 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

      • 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 to set the value at.
        value - The enum numeric value on the wire for schemes to set.
        Returns:
        This builder for chaining.

      • 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.

      • getSecurityList

        public java.util.List<Openapiv2.SecurityRequirement> getSecurityList()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
        Specified by:
        getSecurityList in interface Openapiv2.OperationOrBuilder

      • getSecurityCount

        public int getSecurityCount()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
        Specified by:
        getSecurityCount in interface Openapiv2.OperationOrBuilder

      • getSecurity

        public Openapiv2.SecurityRequirement getSecurity​(int index)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
        Specified by:
        getSecurity in interface Openapiv2.OperationOrBuilder

      • setSecurity

        public Openapiv2.Operation.Builder setSecurity​(int index,
                                               Openapiv2.SecurityRequirement value)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • setSecurity

        public Openapiv2.Operation.Builder setSecurity​(int index,
                                               Openapiv2.SecurityRequirement.Builder builderForValue)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • addSecurity

        public Openapiv2.Operation.Builder addSecurity​(Openapiv2.SecurityRequirement value)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • addSecurity

        public Openapiv2.Operation.Builder addSecurity​(int index,
                                               Openapiv2.SecurityRequirement value)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • addSecurity

        public Openapiv2.Operation.Builder addSecurity​(Openapiv2.SecurityRequirement.Builder builderForValue)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • addSecurity

        public Openapiv2.Operation.Builder addSecurity​(int index,
                                               Openapiv2.SecurityRequirement.Builder builderForValue)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • addAllSecurity

        public Openapiv2.Operation.Builder addAllSecurity​(java.lang.Iterable<? extends Openapiv2.SecurityRequirement> values)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • clearSecurity

        public Openapiv2.Operation.Builder clearSecurity()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • removeSecurity

        public Openapiv2.Operation.Builder removeSecurity​(int index)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getSecurityBuilder

        public Openapiv2.SecurityRequirement.Builder getSecurityBuilder​(int index)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getSecurityOrBuilder

        public Openapiv2.SecurityRequirementOrBuilder getSecurityOrBuilder​(int index)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
        Specified by:
        getSecurityOrBuilder in interface Openapiv2.OperationOrBuilder

      • getSecurityOrBuilderList

        public java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder> getSecurityOrBuilderList()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
        Specified by:
        getSecurityOrBuilderList in interface Openapiv2.OperationOrBuilder

      • addSecurityBuilder

        public Openapiv2.SecurityRequirement.Builder addSecurityBuilder()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • addSecurityBuilder

        public Openapiv2.SecurityRequirement.Builder addSecurityBuilder​(int index)
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getSecurityBuilderList

        public java.util.List<Openapiv2.SecurityRequirement.Builder> getSecurityBuilderList()
         A declaration of which security schemes are applied for this operation. The
 list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements). This
 definition overrides any declared top-level security. To remove a top-level
 security declaration, an empty array can be used.
        repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

      • getExtensionsCount

        public int getExtensionsCount()
        Description copied from interface: Openapiv2.OperationOrBuilder
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;
        Specified by:
        getExtensionsCount in interface Openapiv2.OperationOrBuilder

      • containsExtensions

        public boolean containsExtensions​(java.lang.String key)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;
        Specified by:
        containsExtensions in interface Openapiv2.OperationOrBuilder

      • getExtensionsMap

        public java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensionsMap()
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;
        Specified by:
        getExtensionsMap in interface Openapiv2.OperationOrBuilder

      • getExtensionsOrDefault

        public com.google.protobuf.Value getExtensionsOrDefault​(java.lang.String key,
                                                        com.google.protobuf.Value defaultValue)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;
        Specified by:
        getExtensionsOrDefault in interface Openapiv2.OperationOrBuilder

      • getExtensionsOrThrow

        public com.google.protobuf.Value getExtensionsOrThrow​(java.lang.String key)
         Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;
        Specified by:
        getExtensionsOrThrow in interface Openapiv2.OperationOrBuilder

      • removeExtensions

        public Openapiv2.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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;

      • getMutableExtensions

        @Deprecated
public java.util.Map<java.lang.String,​com.google.protobuf.Value> getMutableExtensions()
        Deprecated.
        Use alternate mutation accessors instead.

      • putExtensions

        public Openapiv2.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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;

      • putAllExtensions

        public Openapiv2.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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 13;

      • hasParameters

        public boolean hasParameters()
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;
        Specified by:
        hasParameters in interface Openapiv2.OperationOrBuilder
        Returns:
        Whether the parameters field is set.

      • getParameters

        public Openapiv2.Parameters getParameters()
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;
        Specified by:
        getParameters in interface Openapiv2.OperationOrBuilder
        Returns:
        The parameters.

      • setParameters

        public Openapiv2.Operation.Builder setParameters​(Openapiv2.Parameters value)
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;

      • setParameters

        public Openapiv2.Operation.Builder setParameters​(Openapiv2.Parameters.Builder builderForValue)
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;

      • mergeParameters

        public Openapiv2.Operation.Builder mergeParameters​(Openapiv2.Parameters value)
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;

      • clearParameters

        public Openapiv2.Operation.Builder clearParameters()
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;

      • getParametersBuilder

        public Openapiv2.Parameters.Builder getParametersBuilder()
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;

      • getParametersOrBuilder

        public Openapiv2.ParametersOrBuilder getParametersOrBuilder()
         Custom parameters such as HTTP request headers.
 See: https://swagger.io/docs/specification/2-0/describing-parameters/
 and https://swagger.io/specification/v2/#parameter-object.
        .grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;
        Specified by:
        getParametersOrBuilder in interface Openapiv2.OperationOrBuilder

      • setUnknownFields

        public final Openapiv2.Operation.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>

      • mergeUnknownFields

        public final Openapiv2.Operation.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Operation.Builder>