c

amf.client.model.domain

TupleShape

case class TupleShape(_internal: plugins.domain.shapes.models.TupleShape) extends DataArrangeShape with Product with Serializable

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, DataArrangeShape, AnyShape, Shape, NamedDomainElement, Linkable, DomainElement, PlatformSecrets, AmfObjectWrapper, Annotable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TupleShape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DataArrangeShape
  7. AnyShape
  8. Shape
  9. NamedDomainElement
  10. Linkable
  11. DomainElement
  12. PlatformSecrets
  13. AmfObjectWrapper
  14. Annotable
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TupleShape()
    Annotations
    @JSExportTopLevel( "model.domain.TupleShape" )
  2. new TupleShape(_internal: plugins.domain.shapes.models.TupleShape)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def additionalItemsSchema: Shape
  5. def and: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  6. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def buildJsonSchema(options: ShapeRenderOptions, exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  9. def buildJsonSchema(options: ShapeRenderOptions): String
    Definition Classes
    AnyShape
  10. def buildJsonSchema(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  11. def buildJsonSchema(): String

    Force a new json schema generation, no matter if the shape was parsed from that kind of expression or if was previously generated.

    Force a new json schema generation, no matter if the shape was parsed from that kind of expression or if was previously generated. Stores the result for futures toJsonSchema invocations. Should use this method when you have mutated this instance

    Definition Classes
    AnyShape
  12. def buildRamlDatatype(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  13. def buildRamlDatatype(): String

    Forces a new RAML Data Type generation, no matter if the shape was parsed from that kind of expression or if was previously generated.

    Forces a new RAML Data Type generation, no matter if the shape was parsed from that kind of expression or if was previously generated. Stores the result for futures toRamlDatatype invocations. Call this method to generate a new RAML Data Type when this instance was mutated. Proxies call to internal AnyShape.toRamlDatatype.

    Definition Classes
    AnyShape
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. def closedItems: BoolField
  16. def comment: StrField
    Definition Classes
    AnyShape
  17. def customDomainProperties: convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement
  18. def customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]
    Definition Classes
    Shape
  19. def customShapePropertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]
    Definition Classes
    Shape
  20. def defaultValue: DataNode
    Definition Classes
    Shape
  21. def defaultValueStr: StrField
    Definition Classes
    Shape
  22. def deprecated: BoolField
    Definition Classes
    Shape
  23. def description: StrField
    Definition Classes
    Shape
  24. def displayName: StrField
    Definition Classes
    Shape
  25. def documentation: CreativeWork
    Definition Classes
    AnyShape
  26. def elseShape: Shape
    Definition Classes
    Shape
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def examples: ClientList[Example]
    Definition Classes
    AnyShape
  29. def extendsNode: convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  30. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. def graph(): Graph
    Definition Classes
    DomainElement
  33. def id: String
    Definition Classes
    DomainElement
  34. def ifShape: Shape
    Definition Classes
    Shape
  35. def inherits: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  36. def inlined(): Boolean
    Definition Classes
    AnyShape
  37. def isDefaultEmpty: Boolean

    Aux method to know when the shape is instance only of any shape and it's because was parsed from an empty (or only with example) payload, an not an explicit type def

    Aux method to know when the shape is instance only of any shape and it's because was parsed from an empty (or only with example) payload, an not an explicit type def

    Definition Classes
    AnyShape
  38. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. def isLink: Boolean
    Definition Classes
    Linkable
  41. def items: ClientList[Shape]
  42. def link[T](label: Option[String]): T
    Definition Classes
    Linkable
  43. def linkCopy(): TupleShape
    Definition Classes
    TupleShape → AnyShape → Linkable
  44. def linkLabel: StrField
    Definition Classes
    Linkable
  45. def linkTarget: convert.CoreClientConverters.ClientOption[DomainElement]
    Definition Classes
    Linkable
  46. def maxItems: IntField
    Definition Classes
    DataArrangeShape
  47. def minItems: IntField
    Definition Classes
    DataArrangeShape
  48. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. def not: Shape
    Definition Classes
    Shape
  51. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  52. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. def or: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape
  54. def parameterValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  55. def parameterValidator(mediaType: String, exec: BaseExecutionEnvironment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  56. def parameterValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  57. def payloadValidator(mediaType: String, env: Environment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  58. def payloadValidator(mediaType: String, exec: BaseExecutionEnvironment): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  59. def payloadValidator(mediaType: String): ClientOption[PayloadValidator]
    Definition Classes
    AnyShape
  60. val platform: Platform
    Definition Classes
    PlatformSecrets
  61. def position: Range
    Definition Classes
    DomainElement
  62. def readOnly: BoolField
    Definition Classes
    Shape
  63. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  64. def thenShape: Shape
    Definition Classes
    Shape
  65. def toJsonSchema(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  66. def toJsonSchema(): String

    if the shape was parsed of a json schema, or has been previously generated a new json schema, returns thar value, otherwise generate a new json schema and store the value for futures invocations

    if the shape was parsed of a json schema, or has been previously generated a new json schema, returns thar value, otherwise generate a new json schema and store the value for futures invocations

    Definition Classes
    AnyShape
  67. def toRamlDatatype(exec: BaseExecutionEnvironment): String
    Definition Classes
    AnyShape
  68. def toRamlDatatype(): String

    If the shape was parsed of RAML, or a new RAML has been previously generated, returns that value, otherwise generates a new RAML Data Type and stores the value for futures invocations.

    If the shape was parsed of RAML, or a new RAML has been previously generated, returns that value, otherwise generates a new RAML Data Type and stores the value for futures invocations. Proxies call to internal AnyShape.toRamlDatatype.

    Definition Classes
    AnyShape
  69. def trackedExample(trackId: String): ClientOption[Example]

    trackId

    parent id of the original payload type with simpleinheritance and the searched example.

    returns

    A ClientOption of the original inlined example, or empty if there is not any example with that track information annotated.

    Definition Classes
    AnyShape
  70. def uniqueItems: BoolField
    Definition Classes
    DataArrangeShape
  71. def validate(fragment: PayloadFragment, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  72. def validate(fragment: PayloadFragment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  73. def validate(fragment: PayloadFragment, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  74. def validate(fragment: PayloadFragment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  75. def validate(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  76. def validate(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  77. def validate(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  78. def validate(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  79. def validateParameter(payload: String, env: Environment, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  80. def validateParameter(payload: String, exec: BaseExecutionEnvironment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  81. def validateParameter(payload: String, env: Environment): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  82. def validateParameter(payload: String): ClientFuture[ValidationReport]
    Definition Classes
    AnyShape
  83. def values: convert.CoreClientConverters.ClientList[DataNode]
    Definition Classes
    Shape
  84. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  87. def withAnd(subShapes: convert.CoreClientConverters.ClientList[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  88. def withClosedItems(closedItems: Boolean): TupleShape.this.type
  89. def withComment(comment: String): TupleShape.this.type
    Definition Classes
    AnyShape
  90. def withCustomDomainProperties(extensions: convert.CoreClientConverters.ClientList[DomainExtension]): TupleShape.this.type
    Definition Classes
    DomainElement
  91. def withCustomShapeProperties(customShapeProperties: convert.CoreClientConverters.ClientList[ShapeExtension]): TupleShape.this.type
    Definition Classes
    Shape
  92. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  93. def withCustomShapePropertyDefinitions(propertyDefinitions: convert.CoreClientConverters.ClientList[PropertyShape]): TupleShape.this.type
    Definition Classes
    Shape
  94. def withDefaultStr(value: String): TupleShape.this.type
    Definition Classes
    Shape
  95. def withDefaultValue(default: DataNode): TupleShape.this.type
    Definition Classes
    Shape
  96. def withDeprecated(deprecated: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  97. def withDescription(description: String): TupleShape.this.type
    Definition Classes
    Shape
  98. def withDisplayName(name: String): TupleShape.this.type
    Definition Classes
    Shape
  99. def withDocumentation(documentation: CreativeWork): TupleShape.this.type
    Definition Classes
    AnyShape
  100. def withElse(elseShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  101. def withExample(mediaType: String): Example
    Definition Classes
    AnyShape
  102. def withExamples(examples: ClientList[Example]): TupleShape.this.type
    Definition Classes
    AnyShape
  103. def withExtendsNode(extension: convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): TupleShape.this.type
    Definition Classes
    DomainElement
  104. def withId(id: String): TupleShape.this.type
    Definition Classes
    DomainElement
  105. def withIf(ifShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  106. def withInherits(inherits: convert.CoreClientConverters.ClientList[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  107. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  108. def withItems(items: ClientList[Shape]): TupleShape.this.type
  109. def withLinkLabel(label: String): TupleShape.this.type
    Definition Classes
    Linkable
  110. def withLinkTarget(target: DomainElement with Linkable): TupleShape.this.type
    Definition Classes
    Linkable
  111. def withMaxItems(maxItems: Int): TupleShape.this.type
    Definition Classes
    DataArrangeShape
  112. def withMinItems(minItems: Int): TupleShape.this.type
    Definition Classes
    DataArrangeShape
  113. def withName(name: String): TupleShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  114. def withNode(shape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  115. def withOr(subShapes: convert.CoreClientConverters.ClientList[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  116. def withReadOnly(readOnly: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  117. def withThen(thenShape: Shape): TupleShape.this.type
    Definition Classes
    Shape
  118. def withUniqueItems(uniqueItems: Boolean): TupleShape.this.type
    Definition Classes
    DataArrangeShape
  119. def withValues(values: convert.CoreClientConverters.ClientList[DataNode]): TupleShape.this.type
    Definition Classes
    Shape
  120. def withWriteOnly(writeOnly: Boolean): TupleShape.this.type
    Definition Classes
    Shape
  121. def withXMLSerialization(xmlSerialization: XMLSerializer): TupleShape.this.type
    Definition Classes
    AnyShape
  122. def withXone(subShapes: convert.CoreClientConverters.ClientList[Shape]): TupleShape.this.type
    Definition Classes
    Shape
  123. def writeOnly: BoolField
    Definition Classes
    Shape
  124. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  125. def xone: convert.CoreClientConverters.ClientList[Shape]
    Definition Classes
    Shape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DataArrangeShape

Inherited from AnyShape

Inherited from Shape

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from AnyRef

Inherited from Any

Ungrouped