Class AuthenticationSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AuthenticationSummary.Builder,
AuthenticationSummary>
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication, and whether that authentication is fully configured.
- 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 <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 Providers property.final List
<AuthenticationProviderTypes> Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.final SamlConfigurationStatus
Specifies whether the workplace's user authentication method is fully configured.final String
Specifies whether the workplace's user authentication method is fully configured.static Class
<? extends AuthenticationSummary.Builder> 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
-
providers
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
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
hasProviders()
method.- Returns:
- Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
-
hasProviders
public final boolean hasProviders()For responses, this returns true if the service returned a value for the Providers 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. -
providersAsStrings
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
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
hasProviders()
method.- Returns:
- Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
-
samlConfigurationStatus
Specifies whether the workplace's user authentication method is fully configured.
If the service returns an enum value that is not available in the current SDK version,
samlConfigurationStatus
will returnSamlConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsamlConfigurationStatusAsString()
.- Returns:
- Specifies whether the workplace's user authentication method is fully configured.
- See Also:
-
samlConfigurationStatusAsString
Specifies whether the workplace's user authentication method is fully configured.
If the service returns an enum value that is not available in the current SDK version,
samlConfigurationStatus
will returnSamlConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsamlConfigurationStatusAsString()
.- Returns:
- Specifies whether the workplace's user authentication method is fully configured.
- See Also:
-
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<AuthenticationSummary.Builder,
AuthenticationSummary> - 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
-