Package software.amazon.awssdk.services.appflow.model

Class OAuth2Properties

java.lang.Object

software.amazon.awssdk.services.appflow.model.OAuth2Properties

All Implemented Interfaces:

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

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

The OAuth 2.0 properties required for OAuth 2.0 authentication.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OAuth2Properties.Builder

Method Summary

Modifier and Type	Method	Description
static OAuth2Properties.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTokenUrlCustomProperties()	For responses, this returns true if the service returned a value for the TokenUrlCustomProperties property.
OAuth2GrantType	oAuth2GrantType()	The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.
String	oAuth2GrantTypeAsString()	The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OAuth2Properties.Builder>	serializableBuilderClass()
OAuth2Properties.Builder	toBuilder()
String	tokenUrl()	The token URL required for OAuth 2.0 authentication.
Map<String,String>	tokenUrlCustomProperties()	Associates your token URL with a map of properties that you define.
String	toString()	Returns a string representation of this object.

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

tokenUrl

public final String tokenUrl()

The token URL required for OAuth 2.0 authentication.

Returns:

The token URL required for OAuth 2.0 authentication.

oAuth2GrantType

public final OAuth2GrantType oAuth2GrantType()

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

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

Returns:

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

See Also:

OAuth2GrantType

oAuth2GrantTypeAsString

public final String oAuth2GrantTypeAsString()

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

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

Returns:

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

See Also:

OAuth2GrantType

hasTokenUrlCustomProperties

public final boolean hasTokenUrlCustomProperties()

For responses, this returns true if the service returned a value for the TokenUrlCustomProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tokenUrlCustomProperties

public final Map<String,String> tokenUrlCustomProperties()

Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your 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 hasTokenUrlCustomProperties() method.

Returns:

Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request.

toBuilder

public OAuth2Properties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OAuth2Properties.Builder,OAuth2Properties>

builder

public static OAuth2Properties.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo