Class CustomPluginConfiguration

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

Configuration information required to create a custom plugin.

See Also:

  • Method Details

    • description

      public final String description()

      A description for your custom plugin configuration.

      Returns:
      A description for your custom plugin configuration.

    • apiSchemaType

      public final APISchemaType apiSchemaType()

      The type of OpenAPI schema to use.

      If the service returns an enum value that is not available in the current SDK version, apiSchemaType will return APISchemaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiSchemaTypeAsString().

      Returns:
      The type of OpenAPI schema to use.
      See Also:

    • apiSchemaTypeAsString

      public final String apiSchemaTypeAsString()

      The type of OpenAPI schema to use.

      If the service returns an enum value that is not available in the current SDK version, apiSchemaType will return APISchemaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiSchemaTypeAsString().

      Returns:
      The type of OpenAPI schema to use.
      See Also:

    • apiSchema

      public final APISchema apiSchema()

      Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

      Returns:
      Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

    • toBuilder

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

    • builder

      public static CustomPluginConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CustomPluginConfiguration.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)

    • 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.