Class: Aws::QBusiness::Types::APISchema

Inherits:
Struct
  • Object
show all
Includes:
Structure, Structure::Union
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

Note:

APISchema is a union - when making an API calls you must set exactly one of the members.

Note:

APISchema is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of APISchema corresponding to the set member.

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.

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema

See Also:

Direct Known Subclasses

Payload, S3, Unknown

Defined Under Namespace

Classes: Payload, S3, Unknown

Constant Summary collapse

SENSITIVE = 
[:payload]

Instance Attribute Summary collapse

Instance Attribute Details

#payload ⇒ String

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

Returns:

  • (String) 


40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 40

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#s3 ⇒ Types::S3

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

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 40

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



40
41
42
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 40

def unknown
  @unknown
end