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

Class UpdateWorkspaceAuthenticationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.grafana.model.GrafanaRequest

software.amazon.awssdk.services.grafana.model.UpdateWorkspaceAuthenticationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateWorkspaceAuthenticationRequest.Builder,UpdateWorkspaceAuthenticationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateWorkspaceAuthenticationRequest
extends GrafanaRequest
implements ToCopyableBuilder<UpdateWorkspaceAuthenticationRequest.Builder,UpdateWorkspaceAuthenticationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateWorkspaceAuthenticationRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<AuthenticationProviderTypes>	authenticationProviders()	Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace.
List<String>	authenticationProvidersAsStrings()	Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace.
static UpdateWorkspaceAuthenticationRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAuthenticationProviders()	For responses, this returns true if the service returned a value for the AuthenticationProviders property.
int	hashCode()
SamlConfiguration	samlConfiguration()	If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateWorkspaceAuthenticationRequest.Builder>	serializableBuilderClass()
UpdateWorkspaceAuthenticationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workspaceId()	The ID of the workspace to update the authentication for.

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

authenticationProviders

public final List<AuthenticationProviderTypes> authenticationProviders()

Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

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

Returns:

Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

hasAuthenticationProviders

public final boolean hasAuthenticationProviders()

For responses, this returns true if the service returned a value for the AuthenticationProviders 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.

authenticationProvidersAsStrings

public final List<String> authenticationProvidersAsStrings()

Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

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

Returns:

Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

samlConfiguration

public final SamlConfiguration samlConfiguration()

If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

Returns:

If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

workspaceId

public final String workspaceId()

The ID of the workspace to update the authentication for.

Returns:

The ID of the workspace to update the authentication for.

toBuilder

public UpdateWorkspaceAuthenticationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateWorkspaceAuthenticationRequest.Builder,UpdateWorkspaceAuthenticationRequest>

Specified by:

toBuilder in class GrafanaRequest

builder

public static UpdateWorkspaceAuthenticationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateWorkspaceAuthenticationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo