Class CustomContentConfiguration

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

The configuration of a CustomContentVisual.

See Also:

  • Method Details

    • contentUrl

      public final String contentUrl()

      The input URL that links to the custom content that you want in the custom visual.

      Returns:
      The input URL that links to the custom content that you want in the custom visual.

    • contentType

      public final CustomContentType contentType()

      The content type of the custom content visual. You can use this to have the visual render as an image.

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

      Returns:
      The content type of the custom content visual. You can use this to have the visual render as an image.
      See Also:

    • contentTypeAsString

      public final String contentTypeAsString()

      The content type of the custom content visual. You can use this to have the visual render as an image.

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

      Returns:
      The content type of the custom content visual. You can use this to have the visual render as an image.
      See Also:

    • imageScaling

      public final CustomContentImageScalingConfiguration imageScaling()

      The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

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

      Returns:
      The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.
      See Also:

    • imageScalingAsString

      public final String imageScalingAsString()

      The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

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

      Returns:
      The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.
      See Also:

    • interactions

      public final VisualInteractionOptions interactions()

      The general visual interactions setup for a visual.

      Returns:
      The general visual interactions setup for a visual.

    • toBuilder

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

    • builder

      public static CustomContentConfiguration.Builder builder()

    • serializableBuilderClass

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