Class APISchema

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.APISchema
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<APISchema.Builder,APISchema>
@Generated("software.amazon.awssdk:codegen") public final class APISchema extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • payload

      public final String 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

      public final 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.

      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

      public APISchema.Builder 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 interface ToCopyableBuilder<APISchema.Builder,APISchema>
      Returns:
      a builder for type T

    • builder

      public static APISchema.Builder builder()

    • serializableBuilderClass

      public static Class<? extends APISchema.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • fromPayload

      public static APISchema fromPayload(String payload)
      Create an instance of this class with payload() 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

      public static APISchema fromS3(S3 s3)
      Create an instance of this class with s3() 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

      public static APISchema fromS3(Consumer<S3.Builder> s3)
      Create an instance of this class with s3() 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

      public APISchema.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be APISchema.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 be APISchema.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.