Packages

case class WebApi(_internal: scala.model.domain.api.WebApi) extends Api[WebApi] with Product with Serializable

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, Api[WebApi], NamedDomainElement, NamedAmfObject, DomainElement, CustomizableElement, PlatformSecrets, AmfObjectWrapper, Annotable, ApiFieldSetter[WebApi], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebApi
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Api
  7. NamedDomainElement
  8. NamedAmfObject
  9. DomainElement
  10. CustomizableElement
  11. PlatformSecrets
  12. AmfObjectWrapper
  13. Annotable
  14. ApiFieldSetter
  15. AnyRef
  16. 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 WebApi()
    Annotations
    @JSExportTopLevel( "WebApi" )
  2. new WebApi(_internal: scala.model.domain.api.WebApi)

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 WebApi to any2stringadd[WebApi] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WebApi, B)
    Implicit
    This member is added by an implicit conversion from WebApi to ArrowAssoc[WebApi] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def accepts: ClientList[StrField]
    Definition Classes
    Api
  7. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  10. def contentType: ClientList[StrField]
    Definition Classes
    Api
  11. def customDomainProperties: core.internal.convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  12. def defaultSchema: StrField
    Definition Classes
    Api
  13. def description: StrField
    Definition Classes
    Api
  14. def documentations: ClientList[CreativeWork]
    Definition Classes
    Api
  15. def endPoints: ClientList[EndPoint]
    Definition Classes
    Api
  16. def ensuring(cond: (WebApi) ⇒ Boolean, msg: ⇒ Any): WebApi
    Implicit
    This member is added by an implicit conversion from WebApi to Ensuring[WebApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (WebApi) ⇒ Boolean): WebApi
    Implicit
    This member is added by an implicit conversion from WebApi to Ensuring[WebApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: ⇒ Any): WebApi
    Implicit
    This member is added by an implicit conversion from WebApi to Ensuring[WebApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): WebApi
    Implicit
    This member is added by an implicit conversion from WebApi to Ensuring[WebApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def extendsNode: core.internal.convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  23. def graph(): Graph
    Definition Classes
    DomainElement
  24. def id: String
    Definition Classes
    DomainElement
  25. def identifier: StrField
    Definition Classes
    Api
  26. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def license: License
    Definition Classes
    Api
  29. def name: StrField
    Definition Classes
    Api → NamedAmfObject
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  33. val platform: Platform
    Definition Classes
    PlatformSecrets
  34. def position: PositionRange
    Definition Classes
    DomainElement
  35. def provider: Organization
    Definition Classes
    Api
  36. def schemes: ClientList[StrField]
    Definition Classes
    Api
  37. def security: ClientList[SecurityRequirement]
    Definition Classes
    Api
  38. def servers: ClientList[Server]
    Definition Classes
    Api
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def tags: ClientList[Tag]
    Definition Classes
    Api
  41. def termsOfService: StrField
    Definition Classes
    Api
  42. def version: StrField
    Definition Classes
    Api
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. def webhooks: ClientList[EndPoint]
    Definition Classes
    Api
  47. def withAccepts(accepts: ClientList[String]): WebApi.this.type

    Set accepts property of this WebApi.

    Set accepts property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  48. def withContentType(contentType: ClientList[String]): WebApi.this.type

    Set contentType property of this WebApi.

    Set contentType property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  49. def withCustomDomainProperties(extensions: core.internal.convert.CoreClientConverters.ClientList[DomainExtension]): WebApi.this.type
    Definition Classes
    DomainElement → CustomizableElement
  50. def withDefaultSchema(schema: String): WebApi.this.type

    Set default schema of this WebApi.

    Set default schema of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  51. def withDefaultServer(url: String): Server

    Adds one Server to the servers property of this WebApi and returns it for population.

    Adds one Server to the servers property of this WebApi and returns it for population. url property of the server is required. This method marks this Server as default. When generating this Server in RAML or OAS2, it will generate a 'baseUri', 'host' or 'basePath', instead of a 'servers' annotation.

    Definition Classes
    Api
  52. def withDescription(description: String): WebApi.this.type
    Definition Classes
    WebApi → ApiFieldSetter
  53. def withDocumentation(documentations: ClientList[CreativeWork]): WebApi.this.type

    Set documentation property of this WebApi using a CreativeWork

    Set documentation property of this WebApi using a CreativeWork

    Definition Classes
    WebApi → ApiFieldSetter
  54. def withDocumentationTitle(title: String): CreativeWork

    Adds one CreativeWork to the documentations property of this WebApi and returns it for population.

    Adds one CreativeWork to the documentations property of this WebApi and returns it for population. Path property of the CreativeWork is required.

    Definition Classes
    Api
  55. def withDocumentationUrl(url: String): CreativeWork

    Adds one CreativeWork to the documentations property of this WebApi and returns it for population.

    Adds one CreativeWork to the documentations property of this WebApi and returns it for population. Path property of the CreativeWork is required.

    Definition Classes
    Api
  56. def withEndPoint(path: String): EndPoint

    Adds one EndPoint to the endPoints property of this WebApi and returns it for population.

    Adds one EndPoint to the endPoints property of this WebApi and returns it for population. Path property of the endPoint is required.

    Definition Classes
    Api
  57. def withEndPoints(endPoints: ClientList[EndPoint]): WebApi.this.type

    Set endPoints property of this WebApi.

    Set endPoints property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  58. def withExtendsNode(extension: core.internal.convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): WebApi.this.type
    Definition Classes
    DomainElement
  59. def withId(id: String): WebApi.this.type
    Definition Classes
    DomainElement
  60. def withIdentifier(identifier: String): WebApi.this.type

    Set identifier property of this WebApi.

    Set identifier property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  61. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  62. def withLicense(license: License): WebApi.this.type

    Set license property of this WebApi using a License

    Set license property of this WebApi using a License

    Definition Classes
    WebApi → ApiFieldSetter
  63. def withName(name: String): WebApi.this.type

    Set name property of this WebApi.

    Set name property of this WebApi.

    Definition Classes
    WebApi → NamedAmfObject
  64. def withProvider(provider: Organization): WebApi.this.type

    Set provider property of this WebApi using a Organization

    Set provider property of this WebApi using a Organization

    Definition Classes
    WebApi → ApiFieldSetter
  65. def withSchemes(schemes: ClientList[String]): WebApi.this.type

    Set schemes property of this WebApi.

    Set schemes property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  66. def withSecurity(security: ClientList[SecurityRequirement]): WebApi.this.type

    Set security property of this WebApi using a list of SecurityRequirement

    Set security property of this WebApi using a list of SecurityRequirement

    Definition Classes
    WebApi → ApiFieldSetter
  67. def withServer(url: String): Server

    Adds one Server to the servers property of this WebApi and returns it for population.

    Adds one Server to the servers property of this WebApi and returns it for population. url property of the server is required.

    Definition Classes
    Api
  68. def withServers(servers: ClientList[Server]): WebApi.this.type

    Set servers property of this WebApi using a list of Server objects.

    Set servers property of this WebApi using a list of Server objects.

    Definition Classes
    WebApi → ApiFieldSetter
  69. def withSummary(summary: String): WebApi.this.type

    Set summary property of this WebApi.

  70. def withTags(tags: ClientList[Tag]): WebApi.this.type

    Set tags of this WebApi.

    Set tags of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  71. def withTermsOfService(terms: String): WebApi.this.type

    Set termsOfService property of this WebApi.

    Set termsOfService property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  72. def withVersion(version: String): WebApi.this.type

    Set version property of this WebApi.

    Set version property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  73. def withWebhooks(webhooks: ClientList[EndPoint]): WebApi.this.type

    Set webhooks property of this WebApi.

    Set webhooks property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  74. def →[B](y: B): (WebApi, B)
    Implicit
    This member is added by an implicit conversion from WebApi to ArrowAssoc[WebApi] 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 WebApi to StringFormat[WebApi] 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 Api[WebApi]

Inherited from NamedDomainElement

Inherited from NamedAmfObject

Inherited from DomainElement

Inherited from CustomizableElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from ApiFieldSetter[WebApi]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped