Class APISchema
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<APISchema.Builder,
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic APISchema.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static APISchema
fromPayload
(String payload) Create an instance of this class withpayload()
initialized to the given value.static APISchema
fromS3
(Consumer<S3.Builder> s3) Create an instance of this class withs3()
initialized to the given value.static APISchema
Create an instance of this class withs3()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
payload()
The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.final S3
s3()
Contains details about the S3 object containing the OpenAPI schema for a custom plugin.static Class
<? extends APISchema.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
payload
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.
-
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:
- Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<APISchema.Builder,
APISchema> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromPayload
Create an instance of this class withpayload()
initialized to the given value.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.
-
fromS3
Create an instance of this class withs3()
initialized to the given value.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.
-
fromS3
Create an instance of this class withs3()
initialized to the given value.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.
-
type
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beAPISchema.Type.UNKNOWN_TO_SDK_VERSION
if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beAPISchema.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-