Class DefaultClientBrandingAttributes
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The forgotten password link.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LoginMessage property.The login message.final String
logoUrl()
The logo.static Class
<? extends DefaultClientBrandingAttributes.Builder> final String
The support email.final String
The support link.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The support email. The company's customer support email address.
-
In each platform type, the
SupportEmail
andSupportLink
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
andSupportLink
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
The support link. The link for the company's customer support page for their WorkSpace.
-
In each platform type, the
SupportEmail
andSupportLink
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
andSupportLink
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
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 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. -
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
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 interfaceToCopyableBuilder<DefaultClientBrandingAttributes.Builder,
DefaultClientBrandingAttributes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-