Package com.openapi.v3

Class Responses

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.openapi.v3.Responses
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResponsesOrBuilder, Serializable
public final class Responses extends com.google.protobuf.GeneratedMessageV3 implements ResponsesOrBuilder
 A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.  The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.  The `default` MAY be used as a default response object for all HTTP codes  that are not covered individually by the specification.  The `Responses Object` MUST contain at least one response code, and it  SHOULD be the response for a successful operation call.
Protobuf type openapi.v3.Responses
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Responses.Builder
    A container for the expected responses of an operation.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_FIELD_NUMBER
     
    static final int
    RESPONSE_OR_REFERENCE_FIELD_NUMBER
     
    static final int
    SPECIFICATION_EXTENSION_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    ResponseOrReference
    getDefault()
    .openapi.v3.ResponseOrReference default = 1 [json_name = "default"];
    static Responses
    getDefaultInstance()
     
    Responses
    getDefaultInstanceForType()
     
    ResponseOrReferenceOrBuilder
    getDefaultOrBuilder()
    .openapi.v3.ResponseOrReference default = 1 [json_name = "default"];
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Responses>
    getParserForType()
     
    NamedResponseOrReference
    getResponseOrReference(int index)
    repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
    int
    getResponseOrReferenceCount()
    repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
    List<NamedResponseOrReference>
    getResponseOrReferenceList()
    repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
    NamedResponseOrReferenceOrBuilder
    getResponseOrReferenceOrBuilder(int index)
    repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
    List<? extends NamedResponseOrReferenceOrBuilder>
    getResponseOrReferenceOrBuilderList()
    repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
    int
    getSerializedSize()
     
    NamedAny
    getSpecificationExtension(int index)
    repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
    int
    getSpecificationExtensionCount()
    repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
    List<NamedAny>
    getSpecificationExtensionList()
    repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
    NamedAnyOrBuilder
    getSpecificationExtensionOrBuilder(int index)
    repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
    List<? extends NamedAnyOrBuilder>
    getSpecificationExtensionOrBuilderList()
    repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
    boolean
    hasDefault()
    .openapi.v3.ResponseOrReference default = 1 [json_name = "default"];
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Responses.Builder
    newBuilder()
     
    static Responses.Builder
    newBuilder(Responses prototype)
     
    Responses.Builder
    newBuilderForType()
     
    protected Responses.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Responses
    parseDelimitedFrom(InputStream input)
     
    static Responses
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Responses
    parseFrom(byte[] data)
     
    static Responses
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Responses
    parseFrom(com.google.protobuf.ByteString data)
     
    static Responses
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Responses
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Responses
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Responses
    parseFrom(InputStream input)
     
    static Responses
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Responses
    parseFrom(ByteBuffer data)
     
    static Responses
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Responses>
    parser()
     
    Responses.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • DEFAULT_FIELD_NUMBER

      public static final int DEFAULT_FIELD_NUMBER
      See Also:

    • RESPONSE_OR_REFERENCE_FIELD_NUMBER

      public static final int RESPONSE_OR_REFERENCE_FIELD_NUMBER
      See Also:

    • SPECIFICATION_EXTENSION_FIELD_NUMBER

      public static final int SPECIFICATION_EXTENSION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasDefault

      public boolean hasDefault()
      .openapi.v3.ResponseOrReference default = 1 [json_name = "default"];
      Specified by:
      hasDefault in interface ResponsesOrBuilder
      Returns:
      Whether the default field is set.

    • getDefault

      public ResponseOrReference getDefault()
      .openapi.v3.ResponseOrReference default = 1 [json_name = "default"];
      Specified by:
      getDefault in interface ResponsesOrBuilder
      Returns:
      The default.

    • getDefaultOrBuilder

      public ResponseOrReferenceOrBuilder getDefaultOrBuilder()
      .openapi.v3.ResponseOrReference default = 1 [json_name = "default"];
      Specified by:
      getDefaultOrBuilder in interface ResponsesOrBuilder

    • getResponseOrReferenceList

      public List<NamedResponseOrReference> getResponseOrReferenceList()
      repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
      Specified by:
      getResponseOrReferenceList in interface ResponsesOrBuilder

    • getResponseOrReferenceOrBuilderList

      public List<? extends NamedResponseOrReferenceOrBuilder> getResponseOrReferenceOrBuilderList()
      repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
      Specified by:
      getResponseOrReferenceOrBuilderList in interface ResponsesOrBuilder

    • getResponseOrReferenceCount

      public int getResponseOrReferenceCount()
      repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
      Specified by:
      getResponseOrReferenceCount in interface ResponsesOrBuilder

    • getResponseOrReference

      public NamedResponseOrReference getResponseOrReference(int index)
      repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
      Specified by:
      getResponseOrReference in interface ResponsesOrBuilder

    • getResponseOrReferenceOrBuilder

      public NamedResponseOrReferenceOrBuilder getResponseOrReferenceOrBuilder(int index)
      repeated .openapi.v3.NamedResponseOrReference response_or_reference = 2 [json_name = "responseOrReference"];
      Specified by:
      getResponseOrReferenceOrBuilder in interface ResponsesOrBuilder

    • getSpecificationExtensionList

      public List<NamedAny> getSpecificationExtensionList()
      repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionList in interface ResponsesOrBuilder

    • getSpecificationExtensionOrBuilderList

      public List<? extends NamedAnyOrBuilder> getSpecificationExtensionOrBuilderList()
      repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionOrBuilderList in interface ResponsesOrBuilder

    • getSpecificationExtensionCount

      public int getSpecificationExtensionCount()
      repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionCount in interface ResponsesOrBuilder

    • getSpecificationExtension

      public NamedAny getSpecificationExtension(int index)
      repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtension in interface ResponsesOrBuilder

    • getSpecificationExtensionOrBuilder

      public NamedAnyOrBuilder getSpecificationExtensionOrBuilder(int index)
      repeated .openapi.v3.NamedAny specification_extension = 3 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionOrBuilder in interface ResponsesOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Responses parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Responses parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Responses parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Responses parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Responses parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Responses parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Responses parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Responses parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Responses parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Responses parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Responses parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Responses parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Responses.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Responses.Builder newBuilder()

    • newBuilder

      public static Responses.Builder newBuilder(Responses prototype)

    • toBuilder

      public Responses.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Responses.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Responses getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Responses> parser()

    • getParserForType

      public com.google.protobuf.Parser<Responses> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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