Class GetResourceOauth2TokenRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetResourceOauth2TokenRequest.Builder,
GetResourceOauth2TokenRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
A map of custom parameters to include in the authorization request to the resource credential provider.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the CustomParameters property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Scopes property.final Oauth2FlowType
The type of flow to be performed.final String
The type of flow to be performed.final String
The name of the resource's credential provider.final String
The callback URL to redirect to after the OAuth 2.0 token retrieval is complete.scopes()
The OAuth scopes being requested.static Class
<? extends GetResourceOauth2TokenRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The identity token of the workload from which you want to retrieve the OAuth2 token.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
workloadIdentityToken
The identity token of the workload from which you want to retrieve the OAuth2 token.
- Returns:
- The identity token of the workload from which you want to retrieve the OAuth2 token.
-
resourceCredentialProviderName
The name of the resource's credential provider.
- Returns:
- The name of the resource's credential provider.
-
hasScopes
public final boolean hasScopes()For responses, this returns true if the service returned a value for the Scopes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
scopes
The OAuth scopes being requested.
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
hasScopes()
method.- Returns:
- The OAuth scopes being requested.
-
oauth2Flow
The type of flow to be performed.
If the service returns an enum value that is not available in the current SDK version,
oauth2Flow
will returnOauth2FlowType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoauth2FlowAsString()
.- Returns:
- The type of flow to be performed.
- See Also:
-
oauth2FlowAsString
The type of flow to be performed.
If the service returns an enum value that is not available in the current SDK version,
oauth2Flow
will returnOauth2FlowType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoauth2FlowAsString()
.- Returns:
- The type of flow to be performed.
- See Also:
-
resourceOauth2ReturnUrl
The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.
- Returns:
- The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.
-
forceAuthentication
Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.
- Returns:
- Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.
-
hasCustomParameters
public final boolean hasCustomParameters()For responses, this returns true if the service returned a value for the CustomParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
customParameters
A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.
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
hasCustomParameters()
method.- Returns:
- A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetResourceOauth2TokenRequest.Builder,
GetResourceOauth2TokenRequest> - Specified by:
toBuilder
in classBedrockAgentCoreRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-