@Generated(value="software.amazon.awssdk:codegen") public final class CreateBackendAuthOAuthConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CreateBackendAuthOAuthConfig.Builder,CreateBackendAuthOAuthConfig>
Creates the OAuth configuration for your Amplify project.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateBackendAuthOAuthConfig.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateBackendAuthOAuthConfig.Builder |
builder() |
String |
domainPrefix()
The domain prefix for your Amplify app.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasOAuthScopes()
Returns true if the OAuthScopes property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasRedirectSignInURIs()
Returns true if the RedirectSignInURIs property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasRedirectSignOutURIs()
Returns true if the RedirectSignOutURIs property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
OAuthGrantType |
oAuthGrantType()
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
|
String |
oAuthGrantTypeAsString()
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
|
List<OAuthScopesElement> |
oAuthScopes()
List of OAuth-related flows that allow your app users to authenticate from your Amplify app.
|
List<String> |
oAuthScopesAsStrings()
List of OAuth-related flows that allow your app users to authenticate from your Amplify app.
|
List<String> |
redirectSignInURIs()
The redirected URI for signing in to your 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 CreateBackendAuthOAuthConfig.Builder> |
serializableBuilderClass() |
SocialProviderSettings |
socialProviderSettings()
The settings for using social identity providers for access to your Amplify app.
|
CreateBackendAuthOAuthConfig.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String domainPrefix()
The domain prefix for your Amplify app.
public final OAuthGrantType oAuthGrantType()
The OAuth grant type that you use 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()
.
OAuthGrantType
public final String oAuthGrantTypeAsString()
The OAuth grant type that you use 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()
.
OAuthGrantType
public final List<OAuthScopesElement> oAuthScopes()
List of OAuth-related flows that allow your app users to authenticate from your Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasOAuthScopes()
to see if a value was sent in this field.
public final boolean hasOAuthScopes()
public final List<String> oAuthScopesAsStrings()
List of OAuth-related flows that allow your app users to authenticate from your Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasOAuthScopes()
to see if a value was sent in this field.
public final boolean hasRedirectSignInURIs()
public final List<String> redirectSignInURIs()
The redirected URI for signing in to your Amplify app.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRedirectSignInURIs()
to see if a value was sent in this field.
public final boolean hasRedirectSignOutURIs()
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.
You can use hasRedirectSignOutURIs()
to see if a value was sent in this field.
public final SocialProviderSettings socialProviderSettings()
The settings for using social identity providers for access to your Amplify app.
public CreateBackendAuthOAuthConfig.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateBackendAuthOAuthConfig.Builder,CreateBackendAuthOAuthConfig>
public static CreateBackendAuthOAuthConfig.Builder builder()
public static Class<? extends CreateBackendAuthOAuthConfig.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()