com.amazonaws.services.qbusiness.model

Class APISchema

java.lang.Object

com.amazonaws.services.qbusiness.model.APISchema

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class APISchema
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
APISchema()

Method Summary

Modifier and Type	Method and Description
APISchema	clone()
boolean	equals(Object obj)
String	getPayload() The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
S3	getS3() Contains details about the S3 object containing the OpenAPI schema for a custom plugin.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setPayload(String payload) The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
void	setS3(S3 s3) Contains details about the S3 object containing the OpenAPI schema for a custom plugin.
String	toString() Returns a string representation of this object.
APISchema	withPayload(String payload) The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
APISchema	withS3(S3 s3) Contains details about the S3 object containing the OpenAPI schema for a custom plugin.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

APISchema

public APISchema()

Method Detail

setPayload

public void setPayload(String payload)

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

Parameters:

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

getPayload

public String getPayload()

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

Returns:

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

withPayload

public APISchema withPayload(String payload)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3

public void setS3(S3 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.

Parameters:

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.

getS3

public S3 getS3()

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:

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

withS3

public APISchema withS3(S3 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public APISchema clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.