Package software.amazon.awssdk.services.grafana.model

Class AuthenticationSummary

java.lang.Object

software.amazon.awssdk.services.grafana.model.AuthenticationSummary

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class AuthenticationSummary
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuthenticationSummary.Builder

Method Summary

Modifier and Type	Method	Description
static AuthenticationSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProviders()	For responses, this returns true if the service returned a value for the Providers property.
List<AuthenticationProviderTypes>	providers()	Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
List<String>	providersAsStrings()	Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
SamlConfigurationStatus	samlConfigurationStatus()	Specifies whether the workplace's user authentication method is fully configured.
String	samlConfigurationStatusAsString()	Specifies whether the workplace's user authentication method is fully configured.
List<SdkField<?>>	sdkFields()
static Class<? extends AuthenticationSummary.Builder>	serializableBuilderClass()
AuthenticationSummary.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

providers

public final List<AuthenticationProviderTypes> 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 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.

providersAsStrings

public final List<String> 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

public final SamlConfigurationStatus 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 return SamlConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from samlConfigurationStatusAsString().

Returns:

Specifies whether the workplace's user authentication method is fully configured.

See Also:

SamlConfigurationStatus

samlConfigurationStatusAsString

public final String 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 return SamlConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from samlConfigurationStatusAsString().

Returns:

Specifies whether the workplace's user authentication method is fully configured.

See Also:

SamlConfigurationStatus

toBuilder

public AuthenticationSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthenticationSummary.Builder,AuthenticationSummary>

builder

public static AuthenticationSummary.Builder builder()

serializableBuilderClass

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