Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Swagger.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.SwaggerOrBuilder, Cloneable
Enclosing class:
Openapiv2.Swagger
public static final class Openapiv2.Swagger.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder> implements Openapiv2.SwaggerOrBuilder
 `Swagger` is a representation of OpenAPI v2 specification's Swagger object.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject
 Example:
  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
    info: {
      title: "Echo API";
      version: "1.0";
      description: ";
      contact: {
        name: "gRPC-Gateway project";
        url: "https://github.com/grpc-ecosystem/grpc-gateway";
        email: "none@example.com";
      };
      license: {
        name: "BSD 3-Clause License";
        url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
      };
    };
    schemes: HTTPS;
    consumes: "application/json";
    produces: "application/json";
  };
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Swagger

  • Method Details

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

    • internalGetMutableMapField

      protected com.google.protobuf.MapField internalGetMutableMapField(int number)
      Overrides:
      internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>

    • clear

      public Openapiv2.Swagger.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.Swagger.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.Swagger.Builder>

    • getDefaultInstanceForType

      public Openapiv2.Swagger getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Openapiv2.Swagger build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Openapiv2.Swagger buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public Openapiv2.Swagger.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.Swagger.Builder>

    • setField

      public Openapiv2.Swagger.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>

    • clearField

      public Openapiv2.Swagger.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.Swagger.Builder>

    • clearOneof

      public Openapiv2.Swagger.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.Swagger.Builder>

    • setRepeatedField

      public Openapiv2.Swagger.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>

    • addRepeatedField

      public Openapiv2.Swagger.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>

    • mergeFrom

      public Openapiv2.Swagger.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.Swagger.Builder>

    • mergeFrom

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>

    • mergeFrom

      public Openapiv2.Swagger.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.Swagger.Builder>
      Throws:
      IOException

    • getSwagger

      public String getSwagger()
       Specifies the OpenAPI Specification version being used. It can be
 used by the OpenAPI UI and other clients to interpret the API listing. The 
 value MUST be "2.0".
      string swagger = 1;
      Specified by:
      getSwagger in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The swagger.

    • getSwaggerBytes

      public com.google.protobuf.ByteString getSwaggerBytes()
       Specifies the OpenAPI Specification version being used. It can be
 used by the OpenAPI UI and other clients to interpret the API listing. The 
 value MUST be "2.0".
      string swagger = 1;
      Specified by:
      getSwaggerBytes in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The bytes for swagger.

    • setSwagger

      public Openapiv2.Swagger.Builder setSwagger(String value)
       Specifies the OpenAPI Specification version being used. It can be
 used by the OpenAPI UI and other clients to interpret the API listing. The 
 value MUST be "2.0".
      string swagger = 1;
      Parameters:
      value - The swagger to set.
      Returns:
      This builder for chaining.

    • clearSwagger

      public Openapiv2.Swagger.Builder clearSwagger()
       Specifies the OpenAPI Specification version being used. It can be
 used by the OpenAPI UI and other clients to interpret the API listing. The 
 value MUST be "2.0".
      string swagger = 1;
      Returns:
      This builder for chaining.

    • setSwaggerBytes

      public Openapiv2.Swagger.Builder setSwaggerBytes(com.google.protobuf.ByteString value)
       Specifies the OpenAPI Specification version being used. It can be
 used by the OpenAPI UI and other clients to interpret the API listing. The 
 value MUST be "2.0".
      string swagger = 1;
      Parameters:
      value - The bytes for swagger to set.
      Returns:
      This builder for chaining.

    • hasInfo

      public boolean hasInfo()
       Provides metadata about the API. The metadata can be used by the 
 clients if needed.
      .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
      Specified by:
      hasInfo in interface Openapiv2.SwaggerOrBuilder
      Returns:
      Whether the info field is set.

    • getInfo

      public Openapiv2.Info getInfo()
       Provides metadata about the API. The metadata can be used by the 
 clients if needed.
      .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
      Specified by:
      getInfo in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The info.

    • setInfo

      public Openapiv2.Swagger.Builder setInfo(Openapiv2.Info value)
       Provides metadata about the API. The metadata can be used by the 
 clients if needed.
      .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;

    • setInfo

      public Openapiv2.Swagger.Builder setInfo(Openapiv2.Info.Builder builderForValue)
       Provides metadata about the API. The metadata can be used by the 
 clients if needed.
      .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;

    • mergeInfo

      public Openapiv2.Swagger.Builder mergeInfo(Openapiv2.Info value)
       Provides metadata about the API. The metadata can be used by the 
 clients if needed.
      .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;

    • clearInfo

      public Openapiv2.Swagger.Builder clearInfo()
       Provides metadata about the API. The metadata can be used by the 
 clients if needed.
      .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;

    • getInfoBuilder

      public Openapiv2.Info.Builder getInfoBuilder()
       Provides metadata about the API. The metadata can be used by the 
 clients if needed.
      .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;

    • getInfoOrBuilder

      public Openapiv2.InfoOrBuilder getInfoOrBuilder()
       Provides metadata about the API. The metadata can be used by the 
 clients if needed.
      .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
      Specified by:
      getInfoOrBuilder in interface Openapiv2.SwaggerOrBuilder

    • getHost

      public String getHost()
       The host (name or ip) serving the API. This MUST be the host only and does 
 not include the scheme nor sub-paths. It MAY include a port. If the host is
 not included, the host serving the documentation is to be used (including
 the port). The host does not support path templating.
      string host = 3;
      Specified by:
      getHost in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The host.

    • getHostBytes

      public com.google.protobuf.ByteString getHostBytes()
       The host (name or ip) serving the API. This MUST be the host only and does 
 not include the scheme nor sub-paths. It MAY include a port. If the host is
 not included, the host serving the documentation is to be used (including
 the port). The host does not support path templating.
      string host = 3;
      Specified by:
      getHostBytes in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The bytes for host.

    • setHost

      public Openapiv2.Swagger.Builder setHost(String value)
       The host (name or ip) serving the API. This MUST be the host only and does 
 not include the scheme nor sub-paths. It MAY include a port. If the host is
 not included, the host serving the documentation is to be used (including
 the port). The host does not support path templating.
      string host = 3;
      Parameters:
      value - The host to set.
      Returns:
      This builder for chaining.

    • clearHost

      public Openapiv2.Swagger.Builder clearHost()
       The host (name or ip) serving the API. This MUST be the host only and does 
 not include the scheme nor sub-paths. It MAY include a port. If the host is
 not included, the host serving the documentation is to be used (including
 the port). The host does not support path templating.
      string host = 3;
      Returns:
      This builder for chaining.

    • setHostBytes

      public Openapiv2.Swagger.Builder setHostBytes(com.google.protobuf.ByteString value)
       The host (name or ip) serving the API. This MUST be the host only and does 
 not include the scheme nor sub-paths. It MAY include a port. If the host is
 not included, the host serving the documentation is to be used (including
 the port). The host does not support path templating.
      string host = 3;
      Parameters:
      value - The bytes for host to set.
      Returns:
      This builder for chaining.

    • getBasePath

      public String getBasePath()
       The base path on which the API is served, which is relative to the host. If
 it is not included, the API is served directly under the host. The value 
 MUST start with a leading slash (/). The basePath does not support path
 templating.
 Note that using `base_path` does not change the endpoint paths that are 
 generated in the resulting OpenAPI file. If you wish to use `base_path`
 with relatively generated OpenAPI paths, the `base_path` prefix must be 
 manually removed from your `google.api.http` paths and your code changed to 
 serve the API from the `base_path`.
      string base_path = 4;
      Specified by:
      getBasePath in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The basePath.

    • getBasePathBytes

      public com.google.protobuf.ByteString getBasePathBytes()
       The base path on which the API is served, which is relative to the host. If
 it is not included, the API is served directly under the host. The value 
 MUST start with a leading slash (/). The basePath does not support path
 templating.
 Note that using `base_path` does not change the endpoint paths that are 
 generated in the resulting OpenAPI file. If you wish to use `base_path`
 with relatively generated OpenAPI paths, the `base_path` prefix must be 
 manually removed from your `google.api.http` paths and your code changed to 
 serve the API from the `base_path`.
      string base_path = 4;
      Specified by:
      getBasePathBytes in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The bytes for basePath.

    • setBasePath

      public Openapiv2.Swagger.Builder setBasePath(String value)
       The base path on which the API is served, which is relative to the host. If
 it is not included, the API is served directly under the host. The value 
 MUST start with a leading slash (/). The basePath does not support path
 templating.
 Note that using `base_path` does not change the endpoint paths that are 
 generated in the resulting OpenAPI file. If you wish to use `base_path`
 with relatively generated OpenAPI paths, the `base_path` prefix must be 
 manually removed from your `google.api.http` paths and your code changed to 
 serve the API from the `base_path`.
      string base_path = 4;
      Parameters:
      value - The basePath to set.
      Returns:
      This builder for chaining.

    • clearBasePath

      public Openapiv2.Swagger.Builder clearBasePath()
       The base path on which the API is served, which is relative to the host. If
 it is not included, the API is served directly under the host. The value 
 MUST start with a leading slash (/). The basePath does not support path
 templating.
 Note that using `base_path` does not change the endpoint paths that are 
 generated in the resulting OpenAPI file. If you wish to use `base_path`
 with relatively generated OpenAPI paths, the `base_path` prefix must be 
 manually removed from your `google.api.http` paths and your code changed to 
 serve the API from the `base_path`.
      string base_path = 4;
      Returns:
      This builder for chaining.

    • setBasePathBytes

      public Openapiv2.Swagger.Builder setBasePathBytes(com.google.protobuf.ByteString value)
       The base path on which the API is served, which is relative to the host. If
 it is not included, the API is served directly under the host. The value 
 MUST start with a leading slash (/). The basePath does not support path
 templating.
 Note that using `base_path` does not change the endpoint paths that are 
 generated in the resulting OpenAPI file. If you wish to use `base_path`
 with relatively generated OpenAPI paths, the `base_path` prefix must be 
 manually removed from your `google.api.http` paths and your code changed to 
 serve the API from the `base_path`.
      string base_path = 4;
      Parameters:
      value - The bytes for basePath to set.
      Returns:
      This builder for chaining.

    • getSchemesList

      public List<Openapiv2.Scheme> getSchemesList()
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Specified by:
      getSchemesList in interface Openapiv2.SwaggerOrBuilder
      Returns:
      A list containing the schemes.

    • getSchemesCount

      public int getSchemesCount()
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Specified by:
      getSchemesCount in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The count of schemes.

    • getSchemes

      public Openapiv2.Scheme getSchemes(int index)
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Specified by:
      getSchemes in interface Openapiv2.SwaggerOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The schemes at the given index.

    • setSchemes

      public Openapiv2.Swagger.Builder setSchemes(int index, Openapiv2.Scheme value)
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Parameters:
      index - The index to set the value at.
      value - The schemes to set.
      Returns:
      This builder for chaining.

    • addSchemes

      public Openapiv2.Swagger.Builder addSchemes(Openapiv2.Scheme value)
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Parameters:
      value - The schemes to add.
      Returns:
      This builder for chaining.

    • addAllSchemes

      public Openapiv2.Swagger.Builder addAllSchemes(Iterable<? extends Openapiv2.Scheme> values)
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Parameters:
      values - The schemes to add.
      Returns:
      This builder for chaining.

    • clearSchemes

      public Openapiv2.Swagger.Builder clearSchemes()
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Returns:
      This builder for chaining.

    • getSchemesValueList

      public List<Integer> getSchemesValueList()
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Specified by:
      getSchemesValueList in interface Openapiv2.SwaggerOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for schemes.

    • getSchemesValue

      public int getSchemesValue(int index)
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Specified by:
      getSchemesValue in interface Openapiv2.SwaggerOrBuilder
      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.Swagger.Builder setSchemesValue(int index, int value)
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of schemes at the given index.

    • addSchemesValue

      public Openapiv2.Swagger.Builder addSchemesValue(int value)
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Parameters:
      value - The enum numeric value on the wire for schemes to add.
      Returns:
      This builder for chaining.

    • addAllSchemesValue

      public Openapiv2.Swagger.Builder addAllSchemesValue(Iterable<Integer> values)
       The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
      Parameters:
      values - The enum numeric values on the wire for schemes to add.
      Returns:
      This builder for chaining.

    • getConsumesList

      public com.google.protobuf.ProtocolStringList getConsumesList()
       A list of MIME types the APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string consumes = 6;
      Specified by:
      getConsumesList in interface Openapiv2.SwaggerOrBuilder
      Returns:
      A list containing the consumes.

    • getConsumesCount

      public int getConsumesCount()
       A list of MIME types the APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string consumes = 6;
      Specified by:
      getConsumesCount in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The count of consumes.

    • getConsumes

      public String getConsumes(int index)
       A list of MIME types the APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string consumes = 6;
      Specified by:
      getConsumes in interface Openapiv2.SwaggerOrBuilder
      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 APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string consumes = 6;
      Specified by:
      getConsumesBytes in interface Openapiv2.SwaggerOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the consumes at the given index.

    • setConsumes

      public Openapiv2.Swagger.Builder setConsumes(int index, String value)
       A list of MIME types the APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. 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.Swagger.Builder addConsumes(String value)
       A list of MIME types the APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. 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.Swagger.Builder addAllConsumes(Iterable<String> values)
       A list of MIME types the APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. 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.Swagger.Builder clearConsumes()
       A list of MIME types the APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string consumes = 6;
      Returns:
      This builder for chaining.

    • addConsumesBytes

      public Openapiv2.Swagger.Builder addConsumesBytes(com.google.protobuf.ByteString value)
       A list of MIME types the APIs can consume. This is global to all APIs but 
 can be overridden on specific API calls. 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 APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string produces = 7;
      Specified by:
      getProducesList in interface Openapiv2.SwaggerOrBuilder
      Returns:
      A list containing the produces.

    • getProducesCount

      public int getProducesCount()
       A list of MIME types the APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string produces = 7;
      Specified by:
      getProducesCount in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The count of produces.

    • getProduces

      public String getProduces(int index)
       A list of MIME types the APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string produces = 7;
      Specified by:
      getProduces in interface Openapiv2.SwaggerOrBuilder
      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 APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string produces = 7;
      Specified by:
      getProducesBytes in interface Openapiv2.SwaggerOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the produces at the given index.

    • setProduces

      public Openapiv2.Swagger.Builder setProduces(int index, String value)
       A list of MIME types the APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. 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.Swagger.Builder addProduces(String value)
       A list of MIME types the APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. 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.Swagger.Builder addAllProduces(Iterable<String> values)
       A list of MIME types the APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. 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.Swagger.Builder clearProduces()
       A list of MIME types the APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.
      repeated string produces = 7;
      Returns:
      This builder for chaining.

    • addProducesBytes

      public Openapiv2.Swagger.Builder addProducesBytes(com.google.protobuf.ByteString value)
       A list of MIME types the APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. 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.SwaggerOrBuilder
       An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.
      map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
      Specified by:
      getResponsesCount in interface Openapiv2.SwaggerOrBuilder

    • containsResponses

      public boolean containsResponses(String key)
       An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.
      map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
      Specified by:
      containsResponses in interface Openapiv2.SwaggerOrBuilder

    • getResponses

      @Deprecated public Map<String,Openapiv2.Response> getResponses()
      Deprecated.
      Use getResponsesMap() instead.
      Specified by:
      getResponses in interface Openapiv2.SwaggerOrBuilder

    • getResponsesMap

      public Map<String,Openapiv2.Response> getResponsesMap()
       An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.
      map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
      Specified by:
      getResponsesMap in interface Openapiv2.SwaggerOrBuilder

    • getResponsesOrDefault

      public Openapiv2.Response getResponsesOrDefault(String key, Openapiv2.Response defaultValue)
       An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.
      map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
      Specified by:
      getResponsesOrDefault in interface Openapiv2.SwaggerOrBuilder

    • getResponsesOrThrow

      public Openapiv2.Response getResponsesOrThrow(String key)
       An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.
      map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
      Specified by:
      getResponsesOrThrow in interface Openapiv2.SwaggerOrBuilder

    • clearResponses

      public Openapiv2.Swagger.Builder clearResponses()

    • removeResponses

      public Openapiv2.Swagger.Builder removeResponses(String key)
       An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.
      map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;

    • getMutableResponses

      @Deprecated public Map<String,Openapiv2.Response> getMutableResponses()
      Deprecated.
      Use alternate mutation accessors instead.

    • putResponses

      public Openapiv2.Swagger.Builder putResponses(String key, Openapiv2.Response value)
       An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.
      map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;

    • putAllResponses

      public Openapiv2.Swagger.Builder putAllResponses(Map<String,Openapiv2.Response> values)
       An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.
      map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;

    • hasSecurityDefinitions

      public boolean hasSecurityDefinitions()
       Security scheme definitions that can be used across the specification.
      .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
      Specified by:
      hasSecurityDefinitions in interface Openapiv2.SwaggerOrBuilder
      Returns:
      Whether the securityDefinitions field is set.

    • getSecurityDefinitions

      public Openapiv2.SecurityDefinitions getSecurityDefinitions()
       Security scheme definitions that can be used across the specification.
      .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
      Specified by:
      getSecurityDefinitions in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The securityDefinitions.

    • setSecurityDefinitions

      public Openapiv2.Swagger.Builder setSecurityDefinitions(Openapiv2.SecurityDefinitions value)
       Security scheme definitions that can be used across the specification.
      .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;

    • setSecurityDefinitions

      public Openapiv2.Swagger.Builder setSecurityDefinitions(Openapiv2.SecurityDefinitions.Builder builderForValue)
       Security scheme definitions that can be used across the specification.
      .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;

    • mergeSecurityDefinitions

      public Openapiv2.Swagger.Builder mergeSecurityDefinitions(Openapiv2.SecurityDefinitions value)
       Security scheme definitions that can be used across the specification.
      .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;

    • clearSecurityDefinitions

      public Openapiv2.Swagger.Builder clearSecurityDefinitions()
       Security scheme definitions that can be used across the specification.
      .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;

    • getSecurityDefinitionsBuilder

      public Openapiv2.SecurityDefinitions.Builder getSecurityDefinitionsBuilder()
       Security scheme definitions that can be used across the specification.
      .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;

    • getSecurityDefinitionsOrBuilder

      public Openapiv2.SecurityDefinitionsOrBuilder getSecurityDefinitionsOrBuilder()
       Security scheme definitions that can be used across the specification.
      .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
      Specified by:
      getSecurityDefinitionsOrBuilder in interface Openapiv2.SwaggerOrBuilder

    • getSecurityList

      public List<Openapiv2.SecurityRequirement> getSecurityList()
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
      Specified by:
      getSecurityList in interface Openapiv2.SwaggerOrBuilder

    • getSecurityCount

      public int getSecurityCount()
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
      Specified by:
      getSecurityCount in interface Openapiv2.SwaggerOrBuilder

    • getSecurity

      public Openapiv2.SecurityRequirement getSecurity(int index)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
      Specified by:
      getSecurity in interface Openapiv2.SwaggerOrBuilder

    • setSecurity

      public Openapiv2.Swagger.Builder setSecurity(int index, Openapiv2.SecurityRequirement value)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • setSecurity

      public Openapiv2.Swagger.Builder setSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • addSecurity

      public Openapiv2.Swagger.Builder addSecurity(Openapiv2.SecurityRequirement value)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • addSecurity

      public Openapiv2.Swagger.Builder addSecurity(int index, Openapiv2.SecurityRequirement value)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • addSecurity

      public Openapiv2.Swagger.Builder addSecurity(Openapiv2.SecurityRequirement.Builder builderForValue)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • addSecurity

      public Openapiv2.Swagger.Builder addSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • addAllSecurity

      public Openapiv2.Swagger.Builder addAllSecurity(Iterable<? extends Openapiv2.SecurityRequirement> values)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • clearSecurity

      public Openapiv2.Swagger.Builder clearSecurity()
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • removeSecurity

      public Openapiv2.Swagger.Builder removeSecurity(int index)
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      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 the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      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 the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
      Specified by:
      getSecurityOrBuilder in interface Openapiv2.SwaggerOrBuilder

    • getSecurityOrBuilderList

      public List<? extends Openapiv2.SecurityRequirementOrBuilder> getSecurityOrBuilderList()
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
      Specified by:
      getSecurityOrBuilderList in interface Openapiv2.SwaggerOrBuilder

    • addSecurityBuilder

      public Openapiv2.SecurityRequirement.Builder addSecurityBuilder()
       A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      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 the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      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 the API as a whole.
 The list of values describes alternative security schemes that can be used 
 (that is, there is a logical OR between the security requirements). 
 Individual operations can override this definition.
      repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;

    • hasExternalDocs

      public boolean hasExternalDocs()
       Additional external documentation.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
      Specified by:
      hasExternalDocs in interface Openapiv2.SwaggerOrBuilder
      Returns:
      Whether the externalDocs field is set.

    • getExternalDocs

      public Openapiv2.ExternalDocumentation getExternalDocs()
       Additional external documentation.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
      Specified by:
      getExternalDocs in interface Openapiv2.SwaggerOrBuilder
      Returns:
      The externalDocs.

    • setExternalDocs

      public Openapiv2.Swagger.Builder setExternalDocs(Openapiv2.ExternalDocumentation value)
       Additional external documentation.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;

    • setExternalDocs

      public Openapiv2.Swagger.Builder setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)
       Additional external documentation.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;

    • mergeExternalDocs

      public Openapiv2.Swagger.Builder mergeExternalDocs(Openapiv2.ExternalDocumentation value)
       Additional external documentation.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;

    • clearExternalDocs

      public Openapiv2.Swagger.Builder clearExternalDocs()
       Additional external documentation.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;

    • getExternalDocsBuilder

      public Openapiv2.ExternalDocumentation.Builder getExternalDocsBuilder()
       Additional external documentation.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;

    • getExternalDocsOrBuilder

      public Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
       Additional external documentation.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
      Specified by:
      getExternalDocsOrBuilder in interface Openapiv2.SwaggerOrBuilder

    • getExtensionsCount

      public int getExtensionsCount()
      Description copied from interface: Openapiv2.SwaggerOrBuilder
      map<string, .google.protobuf.Value> extensions = 15;
      Specified by:
      getExtensionsCount in interface Openapiv2.SwaggerOrBuilder

    • containsExtensions

      public boolean containsExtensions(String key)
      map<string, .google.protobuf.Value> extensions = 15;
      Specified by:
      containsExtensions in interface Openapiv2.SwaggerOrBuilder

    • getExtensions

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

    • getExtensionsMap

      public Map<String,Value> getExtensionsMap()
      map<string, .google.protobuf.Value> extensions = 15;
      Specified by:
      getExtensionsMap in interface Openapiv2.SwaggerOrBuilder

    • getExtensionsOrDefault

      public Value getExtensionsOrDefault(String key, Value defaultValue)
      map<string, .google.protobuf.Value> extensions = 15;
      Specified by:
      getExtensionsOrDefault in interface Openapiv2.SwaggerOrBuilder

    • getExtensionsOrThrow

      public Value getExtensionsOrThrow(String key)
      map<string, .google.protobuf.Value> extensions = 15;
      Specified by:
      getExtensionsOrThrow in interface Openapiv2.SwaggerOrBuilder

    • clearExtensions

      public Openapiv2.Swagger.Builder clearExtensions()

    • removeExtensions

      public Openapiv2.Swagger.Builder removeExtensions(String key)
      map<string, .google.protobuf.Value> extensions = 15;

    • getMutableExtensions

      @Deprecated public Map<String,Value> getMutableExtensions()
      Deprecated.
      Use alternate mutation accessors instead.

    • putExtensions

      public Openapiv2.Swagger.Builder putExtensions(String key, Value value)
      map<string, .google.protobuf.Value> extensions = 15;

    • putAllExtensions

      public Openapiv2.Swagger.Builder putAllExtensions(Map<String,Value> values)
      map<string, .google.protobuf.Value> extensions = 15;

    • setUnknownFields

      public final Openapiv2.Swagger.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.Swagger.Builder>

    • mergeUnknownFields

      public final Openapiv2.Swagger.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.Swagger.Builder>