Package com.openapi.v3

Class Parameter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.openapi.v3.Parameter
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ParameterOrBuilder, Serializable
public final class Parameter extends com.google.protobuf.GeneratedMessageV3 implements ParameterOrBuilder
 Describes a single operation parameter.  A unique parameter is defined by a combination of a name and location.
Protobuf type openapi.v3.Parameter
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Parameter.Builder
    Describes a single operation parameter.

    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
    ALLOW_EMPTY_VALUE_FIELD_NUMBER
     
    static final int
    ALLOW_RESERVED_FIELD_NUMBER
     
    static final int
    CONTENT_FIELD_NUMBER
     
    static final int
    DEPRECATED_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    EXAMPLE_FIELD_NUMBER
     
    static final int
    EXAMPLES_FIELD_NUMBER
     
    static final int
    EXPLODE_FIELD_NUMBER
     
    static final int
    IN_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    REQUIRED_FIELD_NUMBER
     
    static final int
    SCHEMA_FIELD_NUMBER
     
    static final int
    SPECIFICATION_EXTENSION_FIELD_NUMBER
     
    static final int
    STYLE_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)
     
    boolean
    getAllowEmptyValue()
    bool allow_empty_value = 6 [json_name = "allowEmptyValue"];
    boolean
    getAllowReserved()
    bool allow_reserved = 9 [json_name = "allowReserved"];
    MediaTypes
    getContent()
    .openapi.v3.MediaTypes content = 13 [json_name = "content"];
    MediaTypesOrBuilder
    getContentOrBuilder()
    .openapi.v3.MediaTypes content = 13 [json_name = "content"];
    static Parameter
    getDefaultInstance()
     
    Parameter
    getDefaultInstanceForType()
     
    boolean
    getDeprecated()
    bool deprecated = 5 [json_name = "deprecated"];
    String
    getDescription()
    string description = 3 [json_name = "description"];
    com.google.protobuf.ByteString
    getDescriptionBytes()
    string description = 3 [json_name = "description"];
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Any
    getExample()
    .openapi.v3.Any example = 11 [json_name = "example"];
    AnyOrBuilder
    getExampleOrBuilder()
    .openapi.v3.Any example = 11 [json_name = "example"];
    ExamplesOrReferences
    getExamples()
    .openapi.v3.ExamplesOrReferences examples = 12 [json_name = "examples"];
    ExamplesOrReferencesOrBuilder
    getExamplesOrBuilder()
    .openapi.v3.ExamplesOrReferences examples = 12 [json_name = "examples"];
    boolean
    getExplode()
    bool explode = 8 [json_name = "explode"];
    String
    getIn()
    string in = 2 [json_name = "in"];
    com.google.protobuf.ByteString
    getInBytes()
    string in = 2 [json_name = "in"];
    String
    getName()
    string name = 1 [json_name = "name"];
    com.google.protobuf.ByteString
    getNameBytes()
    string name = 1 [json_name = "name"];
    com.google.protobuf.Parser<Parameter>
    getParserForType()
     
    boolean
    getRequired()
    bool required = 4 [json_name = "required"];
    SchemaOrReference
    getSchema()
    .openapi.v3.SchemaOrReference schema = 10 [json_name = "schema"];
    SchemaOrReferenceOrBuilder
    getSchemaOrBuilder()
    .openapi.v3.SchemaOrReference schema = 10 [json_name = "schema"];
    int
    getSerializedSize()
     
    NamedAny
    getSpecificationExtension(int index)
    repeated .openapi.v3.NamedAny specification_extension = 14 [json_name = "specificationExtension"];
    int
    getSpecificationExtensionCount()
    repeated .openapi.v3.NamedAny specification_extension = 14 [json_name = "specificationExtension"];
    List<NamedAny>
    getSpecificationExtensionList()
    repeated .openapi.v3.NamedAny specification_extension = 14 [json_name = "specificationExtension"];
    NamedAnyOrBuilder
    getSpecificationExtensionOrBuilder(int index)
    repeated .openapi.v3.NamedAny specification_extension = 14 [json_name = "specificationExtension"];
    List<? extends NamedAnyOrBuilder>
    getSpecificationExtensionOrBuilderList()
    repeated .openapi.v3.NamedAny specification_extension = 14 [json_name = "specificationExtension"];
    String
    getStyle()
    string style = 7 [json_name = "style"];
    com.google.protobuf.ByteString
    getStyleBytes()
    string style = 7 [json_name = "style"];
    boolean
    hasContent()
    .openapi.v3.MediaTypes content = 13 [json_name = "content"];
    boolean
    hasExample()
    .openapi.v3.Any example = 11 [json_name = "example"];
    boolean
    hasExamples()
    .openapi.v3.ExamplesOrReferences examples = 12 [json_name = "examples"];
    int
    hashCode()
     
    boolean
    hasSchema()
    .openapi.v3.SchemaOrReference schema = 10 [json_name = "schema"];
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Parameter.Builder
    newBuilder()
     
    static Parameter.Builder
    newBuilder(Parameter prototype)
     
    Parameter.Builder
    newBuilderForType()
     
    protected Parameter.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Parameter
    parseDelimitedFrom(InputStream input)
     
    static Parameter
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Parameter
    parseFrom(byte[] data)
     
    static Parameter
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Parameter
    parseFrom(com.google.protobuf.ByteString data)
     
    static Parameter
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Parameter
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Parameter
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Parameter
    parseFrom(InputStream input)
     
    static Parameter
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Parameter
    parseFrom(ByteBuffer data)
     
    static Parameter
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Parameter>
    parser()
     
    Parameter.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

  • 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

    • getName

      public String getName()
      string name = 1 [json_name = "name"];
      Specified by:
      getName in interface ParameterOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      string name = 1 [json_name = "name"];
      Specified by:
      getNameBytes in interface ParameterOrBuilder
      Returns:
      The bytes for name.

    • getIn

      public String getIn()
      string in = 2 [json_name = "in"];
      Specified by:
      getIn in interface ParameterOrBuilder
      Returns:
      The in.

    • getInBytes

      public com.google.protobuf.ByteString getInBytes()
      string in = 2 [json_name = "in"];
      Specified by:
      getInBytes in interface ParameterOrBuilder
      Returns:
      The bytes for in.

    • getDescription

      public String getDescription()
      string description = 3 [json_name = "description"];
      Specified by:
      getDescription in interface ParameterOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
      string description = 3 [json_name = "description"];
      Specified by:
      getDescriptionBytes in interface ParameterOrBuilder
      Returns:
      The bytes for description.

    • getRequired

      public boolean getRequired()
      bool required = 4 [json_name = "required"];
      Specified by:
      getRequired in interface ParameterOrBuilder
      Returns:
      The required.

    • getDeprecated

      public boolean getDeprecated()
      bool deprecated = 5 [json_name = "deprecated"];
      Specified by:
      getDeprecated in interface ParameterOrBuilder
      Returns:
      The deprecated.

    • getAllowEmptyValue

      public boolean getAllowEmptyValue()
      bool allow_empty_value = 6 [json_name = "allowEmptyValue"];
      Specified by:
      getAllowEmptyValue in interface ParameterOrBuilder
      Returns:
      The allowEmptyValue.

    • getStyle

      public String getStyle()
      string style = 7 [json_name = "style"];
      Specified by:
      getStyle in interface ParameterOrBuilder
      Returns:
      The style.

    • getStyleBytes

      public com.google.protobuf.ByteString getStyleBytes()
      string style = 7 [json_name = "style"];
      Specified by:
      getStyleBytes in interface ParameterOrBuilder
      Returns:
      The bytes for style.

    • getExplode

      public boolean getExplode()
      bool explode = 8 [json_name = "explode"];
      Specified by:
      getExplode in interface ParameterOrBuilder
      Returns:
      The explode.

    • getAllowReserved

      public boolean getAllowReserved()
      bool allow_reserved = 9 [json_name = "allowReserved"];
      Specified by:
      getAllowReserved in interface ParameterOrBuilder
      Returns:
      The allowReserved.

    • hasSchema

      public boolean hasSchema()
      .openapi.v3.SchemaOrReference schema = 10 [json_name = "schema"];
      Specified by:
      hasSchema in interface ParameterOrBuilder
      Returns:
      Whether the schema field is set.

    • getSchema

      public SchemaOrReference getSchema()
      .openapi.v3.SchemaOrReference schema = 10 [json_name = "schema"];
      Specified by:
      getSchema in interface ParameterOrBuilder
      Returns:
      The schema.

    • getSchemaOrBuilder

      public SchemaOrReferenceOrBuilder getSchemaOrBuilder()
      .openapi.v3.SchemaOrReference schema = 10 [json_name = "schema"];
      Specified by:
      getSchemaOrBuilder in interface ParameterOrBuilder

    • hasExample

      public boolean hasExample()
      .openapi.v3.Any example = 11 [json_name = "example"];
      Specified by:
      hasExample in interface ParameterOrBuilder
      Returns:
      Whether the example field is set.

    • getExample

      public Any getExample()
      .openapi.v3.Any example = 11 [json_name = "example"];
      Specified by:
      getExample in interface ParameterOrBuilder
      Returns:
      The example.

    • getExampleOrBuilder

      public AnyOrBuilder getExampleOrBuilder()
      .openapi.v3.Any example = 11 [json_name = "example"];
      Specified by:
      getExampleOrBuilder in interface ParameterOrBuilder

    • hasExamples

      public boolean hasExamples()
      .openapi.v3.ExamplesOrReferences examples = 12 [json_name = "examples"];
      Specified by:
      hasExamples in interface ParameterOrBuilder
      Returns:
      Whether the examples field is set.

    • getExamples

      public ExamplesOrReferences getExamples()
      .openapi.v3.ExamplesOrReferences examples = 12 [json_name = "examples"];
      Specified by:
      getExamples in interface ParameterOrBuilder
      Returns:
      The examples.

    • getExamplesOrBuilder

      public ExamplesOrReferencesOrBuilder getExamplesOrBuilder()
      .openapi.v3.ExamplesOrReferences examples = 12 [json_name = "examples"];
      Specified by:
      getExamplesOrBuilder in interface ParameterOrBuilder

    • hasContent

      public boolean hasContent()
      .openapi.v3.MediaTypes content = 13 [json_name = "content"];
      Specified by:
      hasContent in interface ParameterOrBuilder
      Returns:
      Whether the content field is set.

    • getContent

      public MediaTypes getContent()
      .openapi.v3.MediaTypes content = 13 [json_name = "content"];
      Specified by:
      getContent in interface ParameterOrBuilder
      Returns:
      The content.

    • getContentOrBuilder

      public MediaTypesOrBuilder getContentOrBuilder()
      .openapi.v3.MediaTypes content = 13 [json_name = "content"];
      Specified by:
      getContentOrBuilder in interface ParameterOrBuilder

    • getSpecificationExtensionList

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

    • getSpecificationExtensionOrBuilderList

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

    • getSpecificationExtensionCount

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

    • getSpecificationExtension

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

    • getSpecificationExtensionOrBuilder

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

    • 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 Parameter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Parameter.Builder newBuilder()

    • newBuilder

      public static Parameter.Builder newBuilder(Parameter prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Parameter getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Parameter> 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 Parameter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder