Class Model

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

Represents the data structure of a method's request or response payload.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier for the model resource.

      Returns:
      The identifier for the model resource.

    • name

      public final String name()

      The name of the model. Must be an alphanumeric string.

      Returns:
      The name of the model. Must be an alphanumeric string.

    • description

      public final String description()

      The description of the model.

      Returns:
      The description of the model.

    • schema

      public final String schema()

      The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

      Returns:
      The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

    • contentType

      public final String contentType()

      The content-type for the model.

      Returns:
      The content-type for the model.

    • toBuilder

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

    • builder

      public static Model.Builder builder()

    • serializableBuilderClass

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