Class IconImageInput

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

The input for an icon image (logo or favicon). Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

See Also:

  • Method Details

    • blob

      public final SdkBytes blob()

      The image provided as a binary image file.

      Returns:
      The image provided as a binary image file.

    • s3Uri

      public final String s3Uri()

      The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object.

      Returns:
      The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name . You must have read access to the S3 object.

    • toBuilder

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

    • builder

      public static IconImageInput.Builder builder()

    • serializableBuilderClass

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

    • fromBlob

      public static IconImageInput fromBlob(SdkBytes blob)
      Create an instance of this class with blob() initialized to the given value.

      The image provided as a binary image file.

      Parameters:
      blob - The image provided as a binary image file.

    • fromS3Uri

      public static IconImageInput fromS3Uri(String s3Uri)
      Create an instance of this class with s3Uri() initialized to the given value.

      The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object.

      Parameters:
      s3Uri - The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object.

    • type

      public IconImageInput.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be IconImageInput.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be IconImageInput.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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