Package software.amazon.awssdk.services.appfabric.model

Class AppAuthorization

java.lang.Object

software.amazon.awssdk.services.appfabric.model.AppAuthorization

All Implemented Interfaces:

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

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

Contains information about an app authorization.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AppAuthorization.Builder

Method Summary

Modifier and Type	Method	Description
String	app()	The name of the application.
String	appAuthorizationArn()	The Amazon Resource Name (ARN) of the app authorization.
String	appBundleArn()	The Amazon Resource Name (ARN) of the app bundle for the app authorization.
AuthType	authType()	The authorization type.
String	authTypeAsString()	The authorization type.
String	authUrl()	The application URL for the OAuth flow.
static AppAuthorization.Builder	builder()
Instant	createdAt()	The timestamp of when the app authorization was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Persona	persona()	The user persona of the app authorization.
String	personaAsString()	The user persona of the app authorization.
List<SdkField<?>>	sdkFields()
static Class<? extends AppAuthorization.Builder>	serializableBuilderClass()
AppAuthorizationStatus	status()	The state of the app authorization.
String	statusAsString()	The state of the app authorization.
Tenant	tenant()	Contains information about an application tenant, such as the application display name and identifier.
AppAuthorization.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The timestamp of when the app authorization was last updated.

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

appAuthorizationArn

public final String appAuthorizationArn()

The Amazon Resource Name (ARN) of the app authorization.

Returns:

The Amazon Resource Name (ARN) of the app authorization.

appBundleArn

public final String appBundleArn()

The Amazon Resource Name (ARN) of the app bundle for the app authorization.

Returns:

The Amazon Resource Name (ARN) of the app bundle for the app authorization.

app

public final String app()

The name of the application.

Returns:

The name of the application.

tenant

public final Tenant tenant()

Contains information about an application tenant, such as the application display name and identifier.

Returns:

Contains information about an application tenant, such as the application display name and identifier.

authType

public final AuthType authType()

The authorization type.

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

Returns:

The authorization type.

See Also:

AuthType

authTypeAsString

public final String authTypeAsString()

The authorization type.

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

Returns:

The authorization type.

See Also:

AuthType

status

public final AppAuthorizationStatus status()

The state of the app authorization.

The following states are possible:

• PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

• Connected: The app authorization is connected to the application, and is ready to be used.

• ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

• TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

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

Returns:

The state of the app authorization.

The following states are possible:

• PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

• Connected: The app authorization is connected to the application, and is ready to be used.

• ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

• TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

See Also:

AppAuthorizationStatus

statusAsString

public final String statusAsString()

The state of the app authorization.

The following states are possible:

• PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

• Connected: The app authorization is connected to the application, and is ready to be used.

• ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

• TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

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

Returns:

The state of the app authorization.

The following states are possible:

• PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

• Connected: The app authorization is connected to the application, and is ready to be used.

• ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

• TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

See Also:

AppAuthorizationStatus

createdAt

public final Instant createdAt()

The timestamp of when the app authorization was created.

Returns:

The timestamp of when the app authorization was created.

updatedAt

public final Instant updatedAt()

The timestamp of when the app authorization was last updated.

Returns:

The timestamp of when the app authorization was last updated.

persona

public final Persona persona()

The user persona of the app authorization.

This field should always be admin.

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

Returns:

The user persona of the app authorization.

This field should always be admin.

See Also:

Persona

personaAsString

public final String personaAsString()

The user persona of the app authorization.

This field should always be admin.

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

Returns:

The user persona of the app authorization.

This field should always be admin.

See Also:

Persona

authUrl

public final String authUrl()

The application URL for the OAuth flow.

Returns:

The application URL for the OAuth flow.

toBuilder

public AppAuthorization.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AppAuthorization.Builder,AppAuthorization>

builder

public static AppAuthorization.Builder builder()

serializableBuilderClass

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