software.amazon.awssdk.services.amplifybackend.model

Class UpdateBackendAuthOAuthConfig

java.lang.Object

software.amazon.awssdk.services.amplifybackend.model.UpdateBackendAuthOAuthConfig

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateBackendAuthOAuthConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UpdateBackendAuthOAuthConfig.Builder,UpdateBackendAuthOAuthConfig>

The OAuth configurations for authenticating users into your Amplify app.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateBackendAuthOAuthConfig.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateBackendAuthOAuthConfig.Builder	builder()
String	domainPrefix() The Amazon Cognito domain prefix used to create a hosted UI for authentication.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOAuthScopes() For responses, this returns true if the service returned a value for the OAuthScopes property.
boolean	hasRedirectSignInURIs() For responses, this returns true if the service returned a value for the RedirectSignInURIs property.
boolean	hasRedirectSignOutURIs() For responses, this returns true if the service returned a value for the RedirectSignOutURIs property.
OAuthGrantType	oAuthGrantType() The OAuth grant type to allow app users to authenticate from your Amplify app.
String	oAuthGrantTypeAsString() The OAuth grant type to allow app users to authenticate from your Amplify app.
List<OAuthScopesElement>	oAuthScopes() The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
List<String>	oAuthScopesAsStrings() The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
List<String>	redirectSignInURIs() Redirect URLs that OAuth uses when a user signs in to an Amplify app.
List<String>	redirectSignOutURIs() Redirect URLs that OAuth uses when a user signs out of an Amplify app.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateBackendAuthOAuthConfig.Builder>	serializableBuilderClass()
SocialProviderSettings	socialProviderSettings() Describes third-party social federation configurations for allowing your users to sign in with OAuth.
UpdateBackendAuthOAuthConfig.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

domainPrefix

public final String domainPrefix()

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

Returns:

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

oAuthGrantType

public final OAuthGrantType oAuthGrantType()

The OAuth grant type to allow app users to authenticate from your Amplify app.

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

Returns:

The OAuth grant type to allow app users to authenticate from your Amplify app.

See Also:

OAuthGrantType

oAuthGrantTypeAsString

public final String oAuthGrantTypeAsString()

The OAuth grant type to allow app users to authenticate from your Amplify app.

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

Returns:

The OAuth grant type to allow app users to authenticate from your Amplify app.

See Also:

OAuthGrantType

oAuthScopes

public final List<OAuthScopesElement> oAuthScopes()

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

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

Returns:

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

hasOAuthScopes

public final boolean hasOAuthScopes()

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

oAuthScopesAsStrings

public final List<String> oAuthScopesAsStrings()

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

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

Returns:

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

hasRedirectSignInURIs

public final boolean hasRedirectSignInURIs()

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

redirectSignInURIs

public final List<String> redirectSignInURIs()

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

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

Returns:

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

hasRedirectSignOutURIs

public final boolean hasRedirectSignOutURIs()

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

redirectSignOutURIs

public final List<String> redirectSignOutURIs()

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

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

Returns:

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

socialProviderSettings

public final SocialProviderSettings socialProviderSettings()

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

Returns:

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

toBuilder

public UpdateBackendAuthOAuthConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateBackendAuthOAuthConfig.Builder,UpdateBackendAuthOAuthConfig>

builder

public static UpdateBackendAuthOAuthConfig.Builder builder()

serializableBuilderClass

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