Package software.amazon.awssdk.services.bedrockagentcore.model

Class GetResourceOauth2TokenResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreResponse

software.amazon.awssdk.services.bedrockagentcore.model.GetResourceOauth2TokenResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetResourceOauth2TokenResponse.Builder,GetResourceOauth2TokenResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetResourceOauth2TokenResponse.Builder

Method Summary

Modifier and Type	Method	Description
final String	accessToken()	The OAuth 2.0 access token to use.
final String	authorizationUrl()	The URL to initiate the authorization process, provided when the access token requires user authorization.
static GetResourceOauth2TokenResponse.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends GetResourceOauth2TokenResponse.Builder>	serializableBuilderClass()
final SessionStatus	sessionStatus()	Status indicating whether the user's authorization session is in progress or has failed.
final String	sessionStatusAsString()	Status indicating whether the user's authorization session is in progress or has failed.
final String	sessionUri()	Unique identifier for the user's authorization session for retrieving OAuth2 tokens.
GetResourceOauth2TokenResponse.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 Details

authorizationUrl

public final String authorizationUrl()

The URL to initiate the authorization process, provided when the access token requires user authorization.

Returns:

The URL to initiate the authorization process, provided when the access token requires user authorization.

accessToken

public final String accessToken()

The OAuth 2.0 access token to use.

Returns:

The OAuth 2.0 access token to use.

sessionUri

public final String sessionUri()

Unique identifier for the user's authorization session for retrieving OAuth2 tokens. This matches the sessionId from the request and can be used to track the session state.

Returns:

Unique identifier for the user's authorization session for retrieving OAuth2 tokens. This matches the sessionId from the request and can be used to track the session state.

sessionStatus

public final SessionStatus sessionStatus()

Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.

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

Returns:

Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.

See Also:

• SessionStatus

sessionStatusAsString

public final String sessionStatusAsString()

Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.

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

Returns:

Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.

See Also:

• SessionStatus

toBuilder

public GetResourceOauth2TokenResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourceOauth2TokenResponse.Builder,GetResourceOauth2TokenResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetResourceOauth2TokenResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo