Class ComponentBindingPropertiesValueProperties

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

Represents the data binding configuration for a specific property using data stored in Amazon Web Services. For Amazon Web Services connected properties, you can bind a property to data stored in an Amazon S3 bucket, an Amplify DataStore model or an authenticated user attribute.

See Also:

  • Method Details

    • model

      public final String model()

      An Amplify DataStore model.

      Returns:
      An Amplify DataStore model.

    • field

      public final String field()

      The field to bind the data to.

      Returns:
      The field to bind the data to.

    • hasPredicates

      public final boolean hasPredicates()
      For responses, this returns true if the service returned a value for the Predicates 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.

    • predicates

      public final List<Predicate> predicates()

      A list of predicates for binding a component's properties to data.

      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 hasPredicates() method.

      Returns:
      A list of predicates for binding a component's properties to data.

    • userAttribute

      public final String userAttribute()

      An authenticated user attribute.

      Returns:
      An authenticated user attribute.

    • bucket

      public final String bucket()

      An Amazon S3 bucket.

      Returns:
      An Amazon S3 bucket.

    • key

      public final String key()

      The storage key for an Amazon S3 bucket.

      Returns:
      The storage key for an Amazon S3 bucket.

    • defaultValue

      public final String defaultValue()

      The default value to assign to the property.

      Returns:
      The default value to assign to the property.

    • slotName

      public final String slotName()

      The name of a component slot.

      Returns:
      The name of a component slot.

    • toBuilder

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

    • builder

      public static ComponentBindingPropertiesValueProperties.Builder builder()

    • serializableBuilderClass

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