software.amazon.awssdk.services.workspaces.model

Class DefaultClientBrandingAttributes

java.lang.Object

software.amazon.awssdk.services.workspaces.model.DefaultClientBrandingAttributes

All Implemented Interfaces:

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

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

Returns default client branding attributes that were imported. These attributes display on the client login screen.

Client branding attributes are public facing. Ensure that you don't include sensitive information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultClientBrandingAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static DefaultClientBrandingAttributes.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	forgotPasswordLink() The forgotten password link.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLoginMessage() For responses, this returns true if the service returned a value for the LoginMessage property.
Map<String,String>	loginMessage() The login message.
String	logoUrl() The logo.
List<SdkField<?>>	sdkFields()
static Class<? extends DefaultClientBrandingAttributes.Builder>	serializableBuilderClass()
String	supportEmail() The support email.
String	supportLink() The support link.
DefaultClientBrandingAttributes.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

logoUrl

public final String logoUrl()

The logo. The only image format accepted is a binary data object that is converted from a .png file.

Returns:

The logo. The only image format accepted is a binary data object that is converted from a .png file.

supportEmail

public final String supportEmail()

The support email. The company's customer support email address.

• In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

• The default email is workspaces-feedback@amazon.com.

Returns:

The support email. The company's customer support email address.

• In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

• The default email is workspaces-feedback@amazon.com.

supportLink

public final String supportLink()

The support link. The link for the company's customer support page for their WorkSpace.

• In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

• The default support link is workspaces-feedback@amazon.com.

Returns:

The support link. The link for the company's customer support page for their WorkSpace.

• In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

• The default support link is workspaces-feedback@amazon.com.

forgotPasswordLink

public final String forgotPasswordLink()

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

Returns:

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

hasLoginMessage

public final boolean hasLoginMessage()

For responses, this returns true if the service returned a value for the LoginMessage property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

loginMessage

public final Map<String,String> loginMessage()

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .

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 hasLoginMessage() method.

Returns:

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .

toBuilder

public DefaultClientBrandingAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultClientBrandingAttributes.Builder,DefaultClientBrandingAttributes>

builder

public static DefaultClientBrandingAttributes.Builder builder()

serializableBuilderClass

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