Class OAuth2PropertiesInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OAuth2PropertiesInput.Builder,
OAuth2PropertiesInput>
A structure containing properties for OAuth2 in the CreateConnection request.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionThe set of properties required for the the OAuth2AUTHORIZATION_CODE
grant type.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TokenUrlParametersMap property.final OAuth2ClientApplication
The client application type in the CreateConnection request.final OAuth2GrantType
The OAuth2 grant type in the CreateConnection request.final String
The OAuth2 grant type in the CreateConnection request.static Class
<? extends OAuth2PropertiesInput.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
tokenUrl()
The URL of the provider's authentication server, to exchange an authorization code for an access token.A map of parameters that are added to the tokenGET
request.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
oAuth2GrantType
The OAuth2 grant type in the CreateConnection request. For example,
AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
.If the service returns an enum value that is not available in the current SDK version,
oAuth2GrantType
will returnOAuth2GrantType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoAuth2GrantTypeAsString()
.- Returns:
- The OAuth2 grant type in the CreateConnection request. For example,
AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
. - See Also:
-
oAuth2GrantTypeAsString
The OAuth2 grant type in the CreateConnection request. For example,
AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
.If the service returns an enum value that is not available in the current SDK version,
oAuth2GrantType
will returnOAuth2GrantType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoAuth2GrantTypeAsString()
.- Returns:
- The OAuth2 grant type in the CreateConnection request. For example,
AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
. - See Also:
-
oAuth2ClientApplication
The client application type in the CreateConnection request. For example,
AWS_MANAGED
orUSER_MANAGED
.- Returns:
- The client application type in the CreateConnection request. For example,
AWS_MANAGED
orUSER_MANAGED
.
-
tokenUrl
The URL of the provider's authentication server, to exchange an authorization code for an access token.
- Returns:
- The URL of the provider's authentication server, to exchange an authorization code for an access token.
-
hasTokenUrlParametersMap
public final boolean hasTokenUrlParametersMap()For responses, this returns true if the service returned a value for the TokenUrlParametersMap 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. -
tokenUrlParametersMap
A map of parameters that are added to the token
GET
request.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
hasTokenUrlParametersMap()
method.- Returns:
- A map of parameters that are added to the token
GET
request.
-
authorizationCodeProperties
The set of properties required for the the OAuth2
AUTHORIZATION_CODE
grant type.- Returns:
- The set of properties required for the the OAuth2
AUTHORIZATION_CODE
grant type.
-
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<OAuth2PropertiesInput.Builder,
OAuth2PropertiesInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
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. -
getValueForField
-
sdkFields
-