Class UpdateDomainLayoutRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest
software.amazon.awssdk.services.customerprofiles.model.UpdateDomainLayoutRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateDomainLayoutRequest.Builder,UpdateDomainLayoutRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDomainLayoutRequest extends CustomerProfilesRequest implements ToCopyableBuilder<UpdateDomainLayoutRequest.Builder,UpdateDomainLayoutRequest>

  • Method Details

    • domainName

      public final String domainName()

      The unique name of the domain.

      Returns:
      The unique name of the domain.

    • layoutDefinitionName

      public final String layoutDefinitionName()

      The unique name of the layout.

      Returns:
      The unique name of the layout.

    • description

      public final String description()

      The description of the layout

      Returns:
      The description of the layout

    • displayName

      public final String displayName()

      The display name of the layout

      Returns:
      The display name of the layout

    • isDefault

      public final Boolean isDefault()

      If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

      Returns:
      If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

    • layoutType

      public final LayoutType layoutType()

      The type of layout that can be used to view data under a Customer Profiles domain.

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

      Returns:
      The type of layout that can be used to view data under a Customer Profiles domain.
      See Also:

    • layoutTypeAsString

      public final String layoutTypeAsString()

      The type of layout that can be used to view data under a Customer Profiles domain.

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

      Returns:
      The type of layout that can be used to view data under a Customer Profiles domain.
      See Also:

    • layout

      public final String layout()

      A customizable layout that can be used to view data under a Customer Profiles domain.

      Returns:
      A customizable layout that can be used to view data under a Customer Profiles domain.

    • toBuilder

      public UpdateDomainLayoutRequest.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<UpdateDomainLayoutRequest.Builder,UpdateDomainLayoutRequest>
      Specified by:
      toBuilder in class CustomerProfilesRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateDomainLayoutRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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