Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Response.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.ResponseOrBuilder, java.lang.Cloneable
    Enclosing class:
    Openapiv2.Response
    public static final class Openapiv2.Response.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Response.Builder>
implements Openapiv2.ResponseOrBuilder
     `Response` is a representation of OpenAPI v2 specification's Response object.

 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject
    Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Response

    • Method Detail

      • getDescriptor

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

      • internalGetMapFieldReflection

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

      • internalGetMutableMapFieldReflection

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

      • internalGetFieldAccessorTable

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

        public Openapiv2.Response.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.Response.Builder>
        Throws:
        java.io.IOException

      • getDescription

        public java.lang.String getDescription()
         `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.
        string description = 1;
        Specified by:
        getDescription in interface Openapiv2.ResponseOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.
        string description = 1;
        Specified by:
        getDescriptionBytes in interface Openapiv2.ResponseOrBuilder
        Returns:
        The bytes for description.

      • setDescription

        public Openapiv2.Response.Builder setDescription​(java.lang.String value)
         `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.
        string description = 1;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Openapiv2.Response.Builder clearDescription()
         `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.
        string description = 1;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Openapiv2.Response.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         `Description` is a short description of the response.
 GFM syntax can be used for rich text representation.
        string description = 1;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • hasSchema

        public boolean hasSchema()
         `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
        .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
        Specified by:
        hasSchema in interface Openapiv2.ResponseOrBuilder
        Returns:
        Whether the schema field is set.

      • getSchema

        public Openapiv2.Schema getSchema()
         `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
        .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
        Specified by:
        getSchema in interface Openapiv2.ResponseOrBuilder
        Returns:
        The schema.

      • setSchema

        public Openapiv2.Response.Builder setSchema​(Openapiv2.Schema value)
         `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
        .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;

      • setSchema

        public Openapiv2.Response.Builder setSchema​(Openapiv2.Schema.Builder builderForValue)
         `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
        .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;

      • mergeSchema

        public Openapiv2.Response.Builder mergeSchema​(Openapiv2.Schema value)
         `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
        .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;

      • clearSchema

        public Openapiv2.Response.Builder clearSchema()
         `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
        .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;

      • getSchemaBuilder

        public Openapiv2.Schema.Builder getSchemaBuilder()
         `Schema` optionally defines the structure of the response.
 If `Schema` is not provided, it means there is no content to the response.
        .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;

      • getHeadersCount

        public int getHeadersCount()
        Description copied from interface: Openapiv2.ResponseOrBuilder
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
        Specified by:
        getHeadersCount in interface Openapiv2.ResponseOrBuilder

      • containsHeaders

        public boolean containsHeaders​(java.lang.String key)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
        Specified by:
        containsHeaders in interface Openapiv2.ResponseOrBuilder

      • getHeadersMap

        public java.util.Map<java.lang.String,​Openapiv2.Header> getHeadersMap()
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
        Specified by:
        getHeadersMap in interface Openapiv2.ResponseOrBuilder

      • getHeadersOrDefault

        public Openapiv2.Header getHeadersOrDefault​(java.lang.String key,
                                            Openapiv2.Header defaultValue)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
        Specified by:
        getHeadersOrDefault in interface Openapiv2.ResponseOrBuilder

      • getHeadersOrThrow

        public Openapiv2.Header getHeadersOrThrow​(java.lang.String key)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
        Specified by:
        getHeadersOrThrow in interface Openapiv2.ResponseOrBuilder

      • removeHeaders

        public Openapiv2.Response.Builder removeHeaders​(java.lang.String key)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • getMutableHeaders

        @Deprecated
public java.util.Map<java.lang.String,​Openapiv2.Header> getMutableHeaders()
        Deprecated.
        Use alternate mutation accessors instead.

      • putHeaders

        public Openapiv2.Response.Builder putHeaders​(java.lang.String key,
                                             Openapiv2.Header value)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • putAllHeaders

        public Openapiv2.Response.Builder putAllHeaders​(java.util.Map<java.lang.String,​Openapiv2.Header> values)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • putHeadersBuilderIfAbsent

        public Openapiv2.Header.Builder putHeadersBuilderIfAbsent​(java.lang.String key)
         `Headers` A list of headers that are sent with the response.
 `Header` name is expected to be a string in the canonical format of the MIME header key
 See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
        map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;

      • getExamplesCount

        public int getExamplesCount()
        Description copied from interface: Openapiv2.ResponseOrBuilder
         `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
        map<string, string> examples = 4;
        Specified by:
        getExamplesCount in interface Openapiv2.ResponseOrBuilder

      • containsExamples

        public boolean containsExamples​(java.lang.String key)
         `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
        map<string, string> examples = 4;
        Specified by:
        containsExamples in interface Openapiv2.ResponseOrBuilder

      • getExamplesMap

        public java.util.Map<java.lang.String,​java.lang.String> getExamplesMap()
         `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
        map<string, string> examples = 4;
        Specified by:
        getExamplesMap in interface Openapiv2.ResponseOrBuilder

      • getExamplesOrDefault

        public java.lang.String getExamplesOrDefault​(java.lang.String key,
                                             java.lang.String defaultValue)
         `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
        map<string, string> examples = 4;
        Specified by:
        getExamplesOrDefault in interface Openapiv2.ResponseOrBuilder

      • getExamplesOrThrow

        public java.lang.String getExamplesOrThrow​(java.lang.String key)
         `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
        map<string, string> examples = 4;
        Specified by:
        getExamplesOrThrow in interface Openapiv2.ResponseOrBuilder

      • removeExamples

        public Openapiv2.Response.Builder removeExamples​(java.lang.String key)
         `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
        map<string, string> examples = 4;

      • getMutableExamples

        @Deprecated
public java.util.Map<java.lang.String,​java.lang.String> getMutableExamples()
        Deprecated.
        Use alternate mutation accessors instead.

      • putExamples

        public Openapiv2.Response.Builder putExamples​(java.lang.String key,
                                              java.lang.String value)
         `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
        map<string, string> examples = 4;

      • putAllExamples

        public Openapiv2.Response.Builder putAllExamples​(java.util.Map<java.lang.String,​java.lang.String> values)
         `Examples` gives per-mimetype response examples.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
        map<string, string> examples = 4;

      • getExtensionsCount

        public int getExtensionsCount()
        Description copied from interface: Openapiv2.ResponseOrBuilder
         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 = 5;
        Specified by:
        getExtensionsCount in interface Openapiv2.ResponseOrBuilder

      • containsExtensions

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

      • getExtensionsMap

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

      • getExtensionsOrDefault

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

      • getExtensionsOrThrow

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

      • removeExtensions

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

      • getMutableExtensions

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

      • putExtensions

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

      • putAllExtensions

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

      • putExtensionsBuilderIfAbsent

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