Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AssetType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.AssetType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AssetType.Builder,AssetType>

@Generated("software.amazon.awssdk:codegen")
public final class AssetType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AssetType.Builder,AssetType>

An image file from a managed login branding style in a user pool.

This data type is a request parameter of CreateManagedLoginBranding and UpdateManagedLoginBranding, and a response parameter of DescribeManagedLoginBranding.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssetType.Builder

Method Summary

Modifier and Type	Method	Description
static AssetType.Builder	builder()
SdkBytes	bytes()	The image file, in Base64-encoded binary.
AssetCategoryType	category()	The category that the image corresponds to in your managed login configuration.
String	categoryAsString()	The category that the image corresponds to in your managed login configuration.
ColorSchemeModeType	colorMode()	The display-mode target of the asset: light, dark, or browser-adaptive.
String	colorModeAsString()	The display-mode target of the asset: light, dark, or browser-adaptive.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
AssetExtensionType	extension()	The file type of the image file.
String	extensionAsString()	The file type of the image file.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	resourceId()	The ID of the asset.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AssetType.Builder>	serializableBuilderClass()
AssetType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

category

public final AssetCategoryType category()

The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.

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

Returns:

The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.

See Also:

AssetCategoryType

categoryAsString

public final String categoryAsString()

The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.

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

Returns:

The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.

See Also:

AssetCategoryType

colorMode

public final ColorSchemeModeType colorMode()

The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.

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

Returns:

The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.

See Also:

ColorSchemeModeType

colorModeAsString

public final String colorModeAsString()

The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.

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

Returns:

The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.

See Also:

ColorSchemeModeType

extension

public final AssetExtensionType extension()

The file type of the image file.

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

Returns:

The file type of the image file.

See Also:

AssetExtensionType

extensionAsString

public final String extensionAsString()

The file type of the image file.

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

Returns:

The file type of the image file.

See Also:

AssetExtensionType

bytes

public final SdkBytes bytes()

The image file, in Base64-encoded binary.

Returns:

The image file, in Base64-encoded binary.

resourceId

public final String resourceId()

The ID of the asset.

Returns:

The ID of the asset.

toBuilder

public AssetType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssetType.Builder,AssetType>

builder

public static AssetType.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo