Packages

case class Request(_internal: scala.model.domain.Request) extends Message with AbstractRequest with Product with Serializable

Request model class.

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, AbstractRequest, Message, Linkable, DomainElement, CustomizableElement, PlatformSecrets, AmfObjectWrapper, Annotable, NamedDomainElement, NamedAmfObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Request
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AbstractRequest
  7. Message
  8. Linkable
  9. DomainElement
  10. CustomizableElement
  11. PlatformSecrets
  12. AmfObjectWrapper
  13. Annotable
  14. NamedDomainElement
  15. NamedAmfObject
  16. AnyRef
  17. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Request()
    Annotations
    @JSExportTopLevel( "Request" )
  2. new Request(_internal: scala.model.domain.Request)

Type Members

  1. type ParameterType = Parameter
    Definition Classes
    Request → AbstractRequest

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Request to any2stringadd[Request] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Request, B)
    Implicit
    This member is added by an implicit conversion from Request to ArrowAssoc[Request] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def bindings: MessageBindings
    Definition Classes
    Message
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  10. def cookieParameters: ClientList[Parameter]
  11. def correlationId: CorrelationId
    Definition Classes
    Message
  12. def customDomainProperties: core.internal.convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  13. def description: StrField
    Definition Classes
    Message
  14. def displayName: StrField
    Definition Classes
    Message
  15. def documentation: CreativeWork
    Definition Classes
    Message
  16. def ensuring(cond: (Request) ⇒ Boolean, msg: ⇒ Any): Request
    Implicit
    This member is added by an implicit conversion from Request to Ensuring[Request] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (Request) ⇒ Boolean): Request
    Implicit
    This member is added by an implicit conversion from Request to Ensuring[Request] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: ⇒ Any): Request
    Implicit
    This member is added by an implicit conversion from Request to Ensuring[Request] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): Request
    Implicit
    This member is added by an implicit conversion from Request to Ensuring[Request] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def examples: ClientList[Example]
    Definition Classes
    Message
  22. def extendsNode: core.internal.convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  24. def graph(): Graph
    Definition Classes
    DomainElement
  25. def headerExamples: ClientList[Example]
    Definition Classes
    Message
  26. def headerSchema: NodeShape
    Definition Classes
    Message
  27. def headers: ClientList[Parameter]
  28. def id: String
    Definition Classes
    DomainElement
  29. def isAbstract: BoolField
    Definition Classes
    Message
  30. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def isLink: Boolean
    Definition Classes
    Linkable
  33. def link[T](label: String): T
    Definition Classes
    Linkable
  34. def link[T](): T
    Definition Classes
    Linkable
  35. def linkCopy(): Request
    Definition Classes
    Request → Message → Linkable
  36. def linkLabel: StrField
    Definition Classes
    Linkable
  37. def linkTarget: core.internal.convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  38. def messageId: StrField
    Definition Classes
    Message
  39. def name: StrField
    Definition Classes
    AbstractRequest → NamedAmfObject
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  43. def payloads: ClientList[Payload]
    Definition Classes
    Message
  44. val platform: Platform
    Definition Classes
    PlatformSecrets
  45. def position: PositionRange
    Definition Classes
    DomainElement
  46. def queryParameters: ClientList[ParameterType]
    Definition Classes
    Request → AbstractRequest
  47. def queryString: Shape
  48. def refDescription: StrField
    Definition Classes
    Linkable
  49. def refSummary: StrField
    Definition Classes
    Linkable
  50. def required: BoolField
  51. def summary: StrField
    Definition Classes
    Message
  52. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  53. def tags: ClientList[Tag]
    Definition Classes
    Message
  54. def title: StrField
    Definition Classes
    Message
  55. def uriParameters: ClientList[Parameter]
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. def withAbstract(isAbstract: Boolean): Request.this.type
    Definition Classes
    Message
  60. def withBindings(bindings: MessageBindings): Request.this.type
    Definition Classes
    Message
  61. def withCookieParameter(name: String): Parameter

    Adds one Parameter to the cookieParameters property of this Request and returns it for population.

    Adds one Parameter to the cookieParameters property of this Request and returns it for population. Name property of the parameter is required.

  62. def withCookieParameters(cookieParameters: ClientList[Parameter]): Request.this.type

    Set cookieParameters property of this Request.

  63. def withCorrelationId(correlationId: CorrelationId): Request.this.type
    Definition Classes
    Message
  64. def withCustomDomainProperties(extensions: core.internal.convert.CoreClientConverters.ClientList[DomainExtension]): Request.this.type
    Definition Classes
    DomainElement → CustomizableElement
  65. def withDescription(description: String): Request.this.type
    Definition Classes
    Message
  66. def withDisplayName(displayName: String): Request.this.type
    Definition Classes
    Message
  67. def withDocumentation(documentation: CreativeWork): Request.this.type
    Definition Classes
    Message
  68. def withExamples(examples: ClientList[Example]): Request.this.type
    Definition Classes
    Message
  69. def withExtendsNode(extension: core.internal.convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): Request.this.type
    Definition Classes
    DomainElement
  70. def withHeader(name: String): Parameter

    Adds one Parameter]to the headers property of this Request and returns it for population.

    Adds one Parameter]to the headers property of this Request and returns it for population. Name property of the parameter is required.

  71. def withHeaderExamples(examples: ClientList[Example]): Request.this.type
    Definition Classes
    Message
  72. def withHeaderSchema(schema: NodeShape): Request.this.type
    Definition Classes
    Message
  73. def withHeaders(headers: ClientList[Parameter]): Request.this.type

    Set headers property of this Request.

  74. def withId(id: String): Request.this.type
    Definition Classes
    DomainElement
  75. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  76. def withLinkLabel(label: String): Request.this.type
    Definition Classes
    Linkable
  77. def withLinkTarget(target: DomainElement with Linkable): Request.this.type
    Definition Classes
    Linkable
  78. def withMessageId(messageId: String): Request.this.type
    Definition Classes
    Message
  79. def withName(name: String): Request.this.type
    Definition Classes
    AbstractRequest → NamedAmfObject
  80. def withPayload(): Payload
    Definition Classes
    Message
  81. def withPayload(mediaType: String): Payload
    Definition Classes
    Message
  82. def withPayload(mediaType: ClientOption[String]): Payload
    Definition Classes
    Message
  83. def withPayloads(payloads: ClientList[Payload]): Request.this.type
    Definition Classes
    Message
  84. def withQueryParameter(name: String): Parameter

    Adds one Parameter to the queryParameters property of this Request and returns it for population.

    Adds one Parameter to the queryParameters property of this Request and returns it for population. Name property of the parameter is required.

    Definition Classes
    Request → AbstractRequest
  85. def withQueryParameters(parameters: ClientList[ParameterType]): Request.this.type
    Definition Classes
    Request → AbstractRequest
  86. def withQueryString(queryString: Shape): Request.this.type

    Set query string property of this Request.

  87. def withRefDescription(refDescription: String): Request.this.type
    Definition Classes
    Linkable
  88. def withRefSummary(refSummary: String): Request.this.type
    Definition Classes
    Linkable
  89. def withRequired(required: Boolean): Request.this.type

    Set required property of this Request.

  90. def withSummary(summary: String): Request.this.type
    Definition Classes
    Message
  91. def withTags(tags: ClientList[Tag]): Request.this.type
    Definition Classes
    Message
  92. def withTitle(title: String): Request.this.type
    Definition Classes
    Message
  93. def withUriParameter(name: String): Parameter

    Adds one Parameter to the uriParameters property of this Request and returns it for population.

    Adds one Parameter to the uriParameters property of this Request and returns it for population. Name property of the parameter is required.

  94. def withUriParameters(uriParameters: ClientList[Parameter]): Request.this.type

    Set uriParameters property of this Request.

  95. def →[B](y: B): (Request, B)
    Implicit
    This member is added by an implicit conversion from Request to ArrowAssoc[Request] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Request to StringFormat[Request] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AbstractRequest

Inherited from Message

Inherited from Linkable

Inherited from DomainElement

Inherited from CustomizableElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from NamedDomainElement

Inherited from NamedAmfObject

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Request to any2stringadd[Request]

Inherited by implicit conversion StringFormat from Request to StringFormat[Request]

Inherited by implicit conversion Ensuring from Request to Ensuring[Request]

Inherited by implicit conversion ArrowAssoc from Request to ArrowAssoc[Request]

Ungrouped