Package com.openapi.v3

Class Link

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.openapi.v3.Link
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LinkOrBuilder, Serializable
public final class Link extends com.google.protobuf.GeneratedMessageV3 implements LinkOrBuilder
 The `Link object` represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.  Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response.  For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.
Protobuf type openapi.v3.Link
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Link.Builder
    The `Link object` represents a possible design-time link for a response.

    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
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    OPERATION_ID_FIELD_NUMBER
     
    static final int
    OPERATION_REF_FIELD_NUMBER
     
    static final int
    PARAMETERS_FIELD_NUMBER
     
    static final int
    REQUEST_BODY_FIELD_NUMBER
     
    static final int
    SERVER_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)
     
    static Link
    getDefaultInstance()
     
    Link
    getDefaultInstanceForType()
     
    String
    getDescription()
    string description = 5 [json_name = "description"];
    com.google.protobuf.ByteString
    getDescriptionBytes()
    string description = 5 [json_name = "description"];
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getOperationId()
    string operation_id = 2 [json_name = "operationId"];
    com.google.protobuf.ByteString
    getOperationIdBytes()
    string operation_id = 2 [json_name = "operationId"];
    String
    getOperationRef()
    string operation_ref = 1 [json_name = "operationRef"];
    com.google.protobuf.ByteString
    getOperationRefBytes()
    string operation_ref = 1 [json_name = "operationRef"];
    AnyOrExpression
    getParameters()
    .openapi.v3.AnyOrExpression parameters = 3 [json_name = "parameters"];
    AnyOrExpressionOrBuilder
    getParametersOrBuilder()
    .openapi.v3.AnyOrExpression parameters = 3 [json_name = "parameters"];
    com.google.protobuf.Parser<Link>
    getParserForType()
     
    AnyOrExpression
    getRequestBody()
    .openapi.v3.AnyOrExpression request_body = 4 [json_name = "requestBody"];
    AnyOrExpressionOrBuilder
    getRequestBodyOrBuilder()
    .openapi.v3.AnyOrExpression request_body = 4 [json_name = "requestBody"];
    int
    getSerializedSize()
     
    Server
    getServer()
    .openapi.v3.Server server = 6 [json_name = "server"];
    ServerOrBuilder
    getServerOrBuilder()
    .openapi.v3.Server server = 6 [json_name = "server"];
    NamedAny
    getSpecificationExtension(int index)
    repeated .openapi.v3.NamedAny specification_extension = 7 [json_name = "specificationExtension"];
    int
    getSpecificationExtensionCount()
    repeated .openapi.v3.NamedAny specification_extension = 7 [json_name = "specificationExtension"];
    List<NamedAny>
    getSpecificationExtensionList()
    repeated .openapi.v3.NamedAny specification_extension = 7 [json_name = "specificationExtension"];
    NamedAnyOrBuilder
    getSpecificationExtensionOrBuilder(int index)
    repeated .openapi.v3.NamedAny specification_extension = 7 [json_name = "specificationExtension"];
    List<? extends NamedAnyOrBuilder>
    getSpecificationExtensionOrBuilderList()
    repeated .openapi.v3.NamedAny specification_extension = 7 [json_name = "specificationExtension"];
    int
    hashCode()
     
    boolean
    hasParameters()
    .openapi.v3.AnyOrExpression parameters = 3 [json_name = "parameters"];
    boolean
    hasRequestBody()
    .openapi.v3.AnyOrExpression request_body = 4 [json_name = "requestBody"];
    boolean
    hasServer()
    .openapi.v3.Server server = 6 [json_name = "server"];
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Link.Builder
    newBuilder()
     
    static Link.Builder
    newBuilder(Link prototype)
     
    Link.Builder
    newBuilderForType()
     
    protected Link.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Link
    parseDelimitedFrom(InputStream input)
     
    static Link
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Link
    parseFrom(byte[] data)
     
    static Link
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Link
    parseFrom(com.google.protobuf.ByteString data)
     
    static Link
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Link
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Link
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Link
    parseFrom(InputStream input)
     
    static Link
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Link
    parseFrom(ByteBuffer data)
     
    static Link
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Link>
    parser()
     
    Link.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

    • OPERATION_REF_FIELD_NUMBER

      public static final int OPERATION_REF_FIELD_NUMBER
      See Also:

    • OPERATION_ID_FIELD_NUMBER

      public static final int OPERATION_ID_FIELD_NUMBER
      See Also:

    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:

    • REQUEST_BODY_FIELD_NUMBER

      public static final int REQUEST_BODY_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • SERVER_FIELD_NUMBER

      public static final int SERVER_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

    • getOperationRef

      public String getOperationRef()
      string operation_ref = 1 [json_name = "operationRef"];
      Specified by:
      getOperationRef in interface LinkOrBuilder
      Returns:
      The operationRef.

    • getOperationRefBytes

      public com.google.protobuf.ByteString getOperationRefBytes()
      string operation_ref = 1 [json_name = "operationRef"];
      Specified by:
      getOperationRefBytes in interface LinkOrBuilder
      Returns:
      The bytes for operationRef.

    • getOperationId

      public String getOperationId()
      string operation_id = 2 [json_name = "operationId"];
      Specified by:
      getOperationId in interface LinkOrBuilder
      Returns:
      The operationId.

    • getOperationIdBytes

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

    • hasParameters

      public boolean hasParameters()
      .openapi.v3.AnyOrExpression parameters = 3 [json_name = "parameters"];
      Specified by:
      hasParameters in interface LinkOrBuilder
      Returns:
      Whether the parameters field is set.

    • getParameters

      public AnyOrExpression getParameters()
      .openapi.v3.AnyOrExpression parameters = 3 [json_name = "parameters"];
      Specified by:
      getParameters in interface LinkOrBuilder
      Returns:
      The parameters.

    • getParametersOrBuilder

      public AnyOrExpressionOrBuilder getParametersOrBuilder()
      .openapi.v3.AnyOrExpression parameters = 3 [json_name = "parameters"];
      Specified by:
      getParametersOrBuilder in interface LinkOrBuilder

    • hasRequestBody

      public boolean hasRequestBody()
      .openapi.v3.AnyOrExpression request_body = 4 [json_name = "requestBody"];
      Specified by:
      hasRequestBody in interface LinkOrBuilder
      Returns:
      Whether the requestBody field is set.

    • getRequestBody

      public AnyOrExpression getRequestBody()
      .openapi.v3.AnyOrExpression request_body = 4 [json_name = "requestBody"];
      Specified by:
      getRequestBody in interface LinkOrBuilder
      Returns:
      The requestBody.

    • getRequestBodyOrBuilder

      public AnyOrExpressionOrBuilder getRequestBodyOrBuilder()
      .openapi.v3.AnyOrExpression request_body = 4 [json_name = "requestBody"];
      Specified by:
      getRequestBodyOrBuilder in interface LinkOrBuilder

    • getDescription

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

    • getDescriptionBytes

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

    • hasServer

      public boolean hasServer()
      .openapi.v3.Server server = 6 [json_name = "server"];
      Specified by:
      hasServer in interface LinkOrBuilder
      Returns:
      Whether the server field is set.

    • getServer

      public Server getServer()
      .openapi.v3.Server server = 6 [json_name = "server"];
      Specified by:
      getServer in interface LinkOrBuilder
      Returns:
      The server.

    • getServerOrBuilder

      public ServerOrBuilder getServerOrBuilder()
      .openapi.v3.Server server = 6 [json_name = "server"];
      Specified by:
      getServerOrBuilder in interface LinkOrBuilder

    • getSpecificationExtensionList

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

    • getSpecificationExtensionOrBuilderList

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

    • getSpecificationExtensionCount

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

    • getSpecificationExtension

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

    • getSpecificationExtensionOrBuilder

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Link.Builder newBuilder()

    • newBuilder

      public static Link.Builder newBuilder(Link prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Link getDefaultInstance()

    • parser

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

    • getParserForType

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