Class UpdateManagedLoginBrandingRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
-
- software.amazon.awssdk.services.cognitoidentityprovider.model.UpdateManagedLoginBrandingRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateManagedLoginBrandingRequest.Builder,UpdateManagedLoginBrandingRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateManagedLoginBrandingRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<UpdateManagedLoginBrandingRequest.Builder,UpdateManagedLoginBrandingRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateManagedLoginBrandingRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AssetType>assets()An array of image files that you want to apply to roles like backgrounds, logos, and icons.static UpdateManagedLoginBrandingRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAssets()For responses, this returns true if the service returned a value for the Assets property.inthashCode()StringmanagedLoginBrandingId()The ID of the managed login branding style that you want to update.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateManagedLoginBrandingRequest.Builder>serializableBuilderClass()Documentsettings()A JSON file, encoded as aDocumenttype, with the the settings that you want to apply to your style.UpdateManagedLoginBrandingRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleanuseCognitoProvidedValues()When true, applies the default branding style options.StringuserPoolId()The ID of the user pool that contains the managed login branding style that you want to update.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
userPoolId
public final String userPoolId()
The ID of the user pool that contains the managed login branding style that you want to update.
- Returns:
- The ID of the user pool that contains the managed login branding style that you want to update.
-
managedLoginBrandingId
public final String managedLoginBrandingId()
The ID of the managed login branding style that you want to update.
- Returns:
- The ID of the managed login branding style that you want to update.
-
useCognitoProvidedValues
public final Boolean useCognitoProvidedValues()
When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.
When you specify
truefor this option, you must also omit values forSettingsandAssetsin the request.- Returns:
- When true, applies the default branding style options. This option reverts to default style options that
are managed by Amazon Cognito. You can modify them later in the branding designer.
When you specify
truefor this option, you must also omit values forSettingsandAssetsin the request.
-
settings
public final Document settings()
A JSON file, encoded as a
Documenttype, with the the settings that you want to apply to your style.- Returns:
- A JSON file, encoded as a
Documenttype, with the the settings that you want to apply to your style.
-
hasAssets
public final boolean hasAssets()
For responses, this returns true if the service returned a value for the Assets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
assets
public final List<AssetType> assets()
An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
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
hasAssets()method.- Returns:
- An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
-
toBuilder
public UpdateManagedLoginBrandingRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateManagedLoginBrandingRequest.Builder,UpdateManagedLoginBrandingRequest>- Specified by:
toBuilderin classCognitoIdentityProviderRequest
-
builder
public static UpdateManagedLoginBrandingRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateManagedLoginBrandingRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-