Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Operation.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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, Cloneable
Enclosing class:
Openapiv2.Operation
public static final class Openapiv2.Operation.Builder extends com.google.protobuf.GeneratedMessage.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 Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Operation.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Operation.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.Builder<Openapiv2.Operation.Builder>

    • mergeFrom

      public Openapiv2.Operation.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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:
      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 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, 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(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(Iterable<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 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(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 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(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 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(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 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, 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(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(Iterable<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 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, 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(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(Iterable<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(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 Map<String,Openapiv2.Response> getResponses()
      Deprecated.
      Use getResponsesMap() instead.
      Specified by:
      getResponses in interface Openapiv2.OperationOrBuilder

    • getResponsesMap

      public Map<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(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(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(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 Map<String,Openapiv2.Response> getMutableResponses()
      Deprecated.
      Use alternate mutation accessors instead.

    • putResponses

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

    • putResponsesBuilderIfAbsent

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

    • getSchemesList

      public 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(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 List<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(Iterable<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 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(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 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 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(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

    • getExtensions

      @Deprecated public Map<String,com.google.protobuf.Value> getExtensions()
      Deprecated.
      Use getExtensionsMap() instead.
      Specified by:
      getExtensions in interface Openapiv2.OperationOrBuilder

    • getExtensionsMap

      public Map<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(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(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

    • clearExtensions

      public Openapiv2.Operation.Builder clearExtensions()

    • removeExtensions

      public Openapiv2.Operation.Builder removeExtensions(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 Map<String,com.google.protobuf.Value> getMutableExtensions()
      Deprecated.
      Use alternate mutation accessors instead.

    • putExtensions

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

    • putExtensionsBuilderIfAbsent

      public com.google.protobuf.Value.Builder putExtensionsBuilderIfAbsent(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;

    • 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