Class SchemaDefinition

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

A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

See Also:

  • Method Details

    • type

      public final SchemaType type()

      The type of the schema definition. This field specifies the data type of the schema.

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

      Returns:
      The type of the schema definition. This field specifies the data type of the schema.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the schema definition. This field specifies the data type of the schema.

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

      Returns:
      The type of the schema definition. This field specifies the data type of the schema.
      See Also:

    • hasProperties

      public final boolean hasProperties()
      For responses, this returns true if the service returned a value for the Properties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • properties

      public final Map<String,SchemaDefinition> properties()

      The properties of the schema definition. These properties define the fields in the schema.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProperties() method.

      Returns:
      The properties of the schema definition. These properties define the fields in the schema.

    • hasRequired

      public final boolean hasRequired()
      For responses, this returns true if the service returned a value for the Required property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • required

      public final List<String> required()

      The required fields in the schema definition. These fields must be provided when using the schema.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequired() method.

      Returns:
      The required fields in the schema definition. These fields must be provided when using the schema.

    • items

      public final SchemaDefinition items()

      The items in the schema definition. This field is used for array types to define the structure of the array elements.

      Returns:
      The items in the schema definition. This field is used for array types to define the structure of the array elements.

    • description

      public final String description()

      The description of the schema definition. This description provides information about the purpose and usage of the schema.

      Returns:
      The description of the schema definition. This description provides information about the purpose and usage of the schema.

    • toBuilder

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

    • builder

      public static SchemaDefinition.Builder builder()

    • serializableBuilderClass

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