qbusiness/aws.sdk.kotlin.services.qbusiness.model/ApiSchema

ApiSchema

Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

Inheritors

Payload

SdkUnknown

Types

Payload

data class Payload(val value: String) : ApiSchema

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

data class S3(val value: S3) : ApiSchema

Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

SdkUnknown

object SdkUnknown : ApiSchema

Functions

asPayload

fun asPayload(): String

Casts this ApiSchema as a Payload and retrieves its kotlin.String value. Throws an exception if the ApiSchema is not a Payload.

asPayloadOrNull

fun asPayloadOrNull(): String?

Casts this ApiSchema as a Payload and retrieves its kotlin.String value. Returns null if the ApiSchema is not a Payload.

asS3

fun asS3(): S3

Casts this ApiSchema as a S3 and retrieves its aws.sdk.kotlin.services.qbusiness.model.S3 value. Throws an exception if the ApiSchema is not a S3.

asS3OrNull

fun asS3OrNull(): S3?

Casts this ApiSchema as a S3 and retrieves its aws.sdk.kotlin.services.qbusiness.model.S3 value. Returns null if the ApiSchema is not a S3.