software.amazon.awssdk.services.workspacesweb.model

Class UpdateIdentityProviderRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workspacesweb.model.WorkSpacesWebRequest

software.amazon.awssdk.services.workspacesweb.model.UpdateIdentityProviderRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateIdentityProviderRequest.Builder,UpdateIdentityProviderRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateIdentityProviderRequest
extends WorkSpacesWebRequest
implements ToCopyableBuilder<UpdateIdentityProviderRequest.Builder,UpdateIdentityProviderRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateIdentityProviderRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateIdentityProviderRequest.Builder	builder()
String	clientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdentityProviderDetails() For responses, this returns true if the service returned a value for the IdentityProviderDetails property.
String	identityProviderArn() The ARN of the identity provider.
Map<String,String>	identityProviderDetails() The details of the identity provider.
String	identityProviderName() The name of the identity provider.
IdentityProviderType	identityProviderType() The type of the identity provider.
String	identityProviderTypeAsString() The type of the identity provider.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateIdentityProviderRequest.Builder>	serializableBuilderClass()
UpdateIdentityProviderRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

identityProviderArn

public final String identityProviderArn()

The ARN of the identity provider.

Returns:

The ARN of the identity provider.

hasIdentityProviderDetails

public final boolean hasIdentityProviderDetails()

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

identityProviderDetails

public final Map<String,String> identityProviderDetails()

The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

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

Returns:

The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

identityProviderName

public final String identityProviderName()

The name of the identity provider.

Returns:

The name of the identity provider.

identityProviderType

public final IdentityProviderType identityProviderType()

The type of the identity provider.

If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().

Returns:

The type of the identity provider.

See Also:

IdentityProviderType

identityProviderTypeAsString

public final String identityProviderTypeAsString()

The type of the identity provider.

If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().

Returns:

The type of the identity provider.

See Also:

IdentityProviderType

toBuilder

public UpdateIdentityProviderRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIdentityProviderRequest.Builder,UpdateIdentityProviderRequest>

Specified by:

toBuilder in class WorkSpacesWebRequest

builder

public static UpdateIdentityProviderRequest.Builder builder()

serializableBuilderClass

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