ImmutableOAuth2Defaults (aws-custom-connector-sdk 1.0.8 API)

java.lang.Object
- com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth.ImmutableOAuth2Defaults

All Implemented Interfaces:: OAuth2Defaults

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
public final class ImmutableOAuth2Defaults
extends Object
implements OAuth2Defaults

Immutable implementation of OAuth2Defaults.

Use the builder to create immutable instances: ImmutableOAuth2Defaults.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableOAuth2Defaults.Builder
Builds instances of type ImmutableOAuth2Defaults.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableOAuth2Defaults.Builder` Builds instances of type `ImmutableOAuth2Defaults`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addBasicAuthHeader()` Specifies if clientId and clientSecret should be added to basic auth header
`com.google.common.collect.ImmutableList<String>`	`authURL()` Auth URLs.
`static ImmutableOAuth2Defaults.Builder`	`builder()` Creates a builder for `ImmutableOAuth2Defaults`.
`static ImmutableOAuth2Defaults`	`copyOf(OAuth2Defaults instance)` Creates an immutable copy of a `OAuth2Defaults` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableOAuth2Defaults` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `oAuthScopes`, `tokenURL`, `authURL`, `oAuth2GrantTypesSupported`, `oAuth2ContentType`, `oAuth2MethodType`, `oauth2CustomProperties`, `addBasicAuthHeader`.
`OAuth2ContentType`	`oAuth2ContentType()` OAuth2 Content type to use in the token request header.
`com.google.common.collect.ImmutableList<OAuth2CustomParameter>`	`oauth2CustomProperties()` OAuth2 custom parameters needed by the connector.
`com.google.common.collect.ImmutableList<OAuth2GrantType>`	`oAuth2GrantTypesSupported()` OAuth2 Grant types supported by connector.
`OAuth2MethodType`	`oAuth2MethodType()` OAuth2 Http method to use for the token request.
`com.google.common.collect.ImmutableList<String>`	`oAuthScopes()` OAuth Scopes.
`com.google.common.collect.ImmutableList<String>`	`tokenURL()` Token URLs.
`String`	`toString()` Prints the immutable value `OAuth2Defaults` with attribute values.
`ImmutableOAuth2Defaults`	`withAddBasicAuthHeader(boolean value)` Copy the current immutable object by setting a value for the `addBasicAuthHeader` attribute.
`ImmutableOAuth2Defaults`	`withAuthURL(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `authURL`.
`ImmutableOAuth2Defaults`	`withAuthURL(String... elements)` Copy the current immutable object with elements that replace the content of `authURL`.
`ImmutableOAuth2Defaults`	`withOAuth2ContentType(OAuth2ContentType value)` Copy the current immutable object by setting a value for the `oAuth2ContentType` attribute.
`ImmutableOAuth2Defaults`	`withOauth2CustomProperties(Iterable<? extends OAuth2CustomParameter> elements)` Copy the current immutable object with elements that replace the content of `oauth2CustomProperties`.
`ImmutableOAuth2Defaults`	`withOauth2CustomProperties(OAuth2CustomParameter... elements)` Copy the current immutable object with elements that replace the content of `oauth2CustomProperties`.
`ImmutableOAuth2Defaults`	`withOAuth2GrantTypesSupported(Iterable<? extends OAuth2GrantType> elements)` Copy the current immutable object with elements that replace the content of `oAuth2GrantTypesSupported`.
`ImmutableOAuth2Defaults`	`withOAuth2GrantTypesSupported(OAuth2GrantType... elements)` Copy the current immutable object with elements that replace the content of `oAuth2GrantTypesSupported`.
`ImmutableOAuth2Defaults`	`withOAuth2MethodType(OAuth2MethodType value)` Copy the current immutable object by setting a value for the `oAuth2MethodType` attribute.
`ImmutableOAuth2Defaults`	`withOAuthScopes(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `oAuthScopes`.
`ImmutableOAuth2Defaults`	`withOAuthScopes(String... elements)` Copy the current immutable object with elements that replace the content of `oAuthScopes`.
`ImmutableOAuth2Defaults`	`withTokenURL(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `tokenURL`.
`ImmutableOAuth2Defaults`	`withTokenURL(String... elements)` Copy the current immutable object with elements that replace the content of `tokenURL`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - oAuthScopes
```
@Nullable
public com.google.common.collect.ImmutableList<String> oAuthScopes()
```
    OAuth Scopes. Required for OAuth2GrantType - AUTHORIZATION_CODE.
    
    Specified by:
    
    oAuthScopes in interface OAuth2Defaults
  - tokenURL
```
public com.google.common.collect.ImmutableList<String> tokenURL()
```
    Token URLs. Required for both OAuth2GrantType - AUTHORIZATION_CODE and CLIENT_CREDENTIALS. This URL can be in two format - Static and Template based where we need the input from the Customer to build the complete URL. For Static URLs you can add the URL directly to this list like - https://login.salesforce.com/services/oauth2/token And for template based URLs, you can use this format - https://{{SALESFORCE_SUBDOMAIN}}.auth.marketingcloudapis.com/v2/token where the SALESFORCE_SUBDOMAIN will be the user input and AppFlow will ask the customers to provide its value while configuring the connector profile.
    
    Specified by:
    
    tokenURL in interface OAuth2Defaults
  - authURL
```
@Nullable
public com.google.common.collect.ImmutableList<String> authURL()
```
    Auth URLs. Required for OAuth2GrantType - AUTHORIZATION_CODE. This URL can be in two format - Static and Template based where we need the input from the Customer to build the complete URL. For Static URLs you can add the URL directly to this list like - https://login.salesforce.com/services/oauth2/token. And for template based URLs, you can use this format - https://{{SALESFORCE_SUBDOMAIN}}.auth.marketingcloudapis.com/v2/token where the SALESFORCE_SUBDOMAIN will be the user input and AppFlow will ask the customers to provide its value while configuring the connector profile.
    
    Specified by:
    
    authURL in interface OAuth2Defaults
  - oAuth2GrantTypesSupported
```
public com.google.common.collect.ImmutableList<OAuth2GrantType> oAuth2GrantTypesSupported()
```
    OAuth2 Grant types supported by connector.
    
    Specified by:
    
    oAuth2GrantTypesSupported in interface OAuth2Defaults
  - oAuth2ContentType
```
public OAuth2ContentType oAuth2ContentType()
```
    OAuth2 Content type to use in the token request header. Default: "application/x-www-form-urlencoded"
    
    Specified by:
    
    oAuth2ContentType in interface OAuth2Defaults
  - oAuth2MethodType
```
public OAuth2MethodType oAuth2MethodType()
```
    OAuth2 Http method to use for the token request. Default: "POST"
    
    Specified by:
    
    oAuth2MethodType in interface OAuth2Defaults
  - oauth2CustomProperties
```
@Nullable
public com.google.common.collect.ImmutableList<OAuth2CustomParameter> oauth2CustomProperties()
```
    OAuth2 custom parameters needed by the connector. In case of 3 legged OAuth2 AppFlow have clientId and scope defined as the default parameter for AUTH_URL to generate the Authorization code. Connector developer doesn't have to define clientId and scope as OAuth2Custom Parameter for AUTH_URL.
    
    Specified by:
    
    oauth2CustomProperties in interface OAuth2Defaults
  - addBasicAuthHeader
```
public boolean addBasicAuthHeader()
```
    Specifies if clientId and clientSecret should be added to basic auth header
    
    Specified by:
    
    addBasicAuthHeader in interface OAuth2Defaults
  - withOAuthScopes
```
public final ImmutableOAuth2Defaults withOAuthScopes(@Nullable
                                                     String... elements)
```
    Copy the current immutable object with elements that replace the content of oAuthScopes.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withOAuthScopes
```
public final ImmutableOAuth2Defaults withOAuthScopes(@Nullable
                                                     Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of oAuthScopes. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of oAuthScopes elements to set
    
    Returns:
    
    A modified copy of this object
  - withTokenURL
```
public final ImmutableOAuth2Defaults withTokenURL(String... elements)
```
    Copy the current immutable object with elements that replace the content of tokenURL.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withTokenURL
```
public final ImmutableOAuth2Defaults withTokenURL(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of tokenURL. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of tokenURL elements to set
    
    Returns:
    
    A modified copy of this object
  - withAuthURL
```
public final ImmutableOAuth2Defaults withAuthURL(@Nullable
                                                 String... elements)
```
    Copy the current immutable object with elements that replace the content of authURL.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withAuthURL
```
public final ImmutableOAuth2Defaults withAuthURL(@Nullable
                                                 Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of authURL. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of authURL elements to set
    
    Returns:
    
    A modified copy of this object
  - withOAuth2GrantTypesSupported
```
public final ImmutableOAuth2Defaults withOAuth2GrantTypesSupported(OAuth2GrantType... elements)
```
    Copy the current immutable object with elements that replace the content of oAuth2GrantTypesSupported.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withOAuth2GrantTypesSupported
```
public final ImmutableOAuth2Defaults withOAuth2GrantTypesSupported(Iterable<? extends OAuth2GrantType> elements)
```
    Copy the current immutable object with elements that replace the content of oAuth2GrantTypesSupported. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of oAuth2GrantTypesSupported elements to set
    
    Returns:
    
    A modified copy of this object
  - withOAuth2ContentType
```
public final ImmutableOAuth2Defaults withOAuth2ContentType(OAuth2ContentType value)
```
    Copy the current immutable object by setting a value for the oAuth2ContentType attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for oAuth2ContentType
    
    Returns:
    
    A modified copy of the this object
  - withOAuth2MethodType
```
public final ImmutableOAuth2Defaults withOAuth2MethodType(OAuth2MethodType value)
```
    Copy the current immutable object by setting a value for the oAuth2MethodType attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for oAuth2MethodType
    
    Returns:
    
    A modified copy of the this object
  - withOauth2CustomProperties
```
public final ImmutableOAuth2Defaults withOauth2CustomProperties(@Nullable
                                                                OAuth2CustomParameter... elements)
```
    Copy the current immutable object with elements that replace the content of oauth2CustomProperties.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withOauth2CustomProperties
```
public final ImmutableOAuth2Defaults withOauth2CustomProperties(@Nullable
                                                                Iterable<? extends OAuth2CustomParameter> elements)
```
    Copy the current immutable object with elements that replace the content of oauth2CustomProperties. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of oauth2CustomProperties elements to set
    
    Returns:
    
    A modified copy of this object
  - withAddBasicAuthHeader
```
public final ImmutableOAuth2Defaults withAddBasicAuthHeader(boolean value)
```
    Copy the current immutable object by setting a value for the addBasicAuthHeader attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for addBasicAuthHeader
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableOAuth2Defaults that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: oAuthScopes, tokenURL, authURL, oAuth2GrantTypesSupported, oAuth2ContentType, oAuth2MethodType, oauth2CustomProperties, addBasicAuthHeader.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value OAuth2Defaults with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableOAuth2Defaults copyOf(OAuth2Defaults instance)
```
    Creates an immutable copy of a OAuth2Defaults value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable OAuth2Defaults instance
  - builder
```
public static ImmutableOAuth2Defaults.Builder builder()
```
    Creates a builder for ImmutableOAuth2Defaults.
```
 ImmutableOAuth2Defaults.builder()
    .oAuthScopes(List&lt;String&gt; | null) // nullable oAuthScopes
    .addTokenURL|addAllTokenURL(String) // tokenURL elements
    .authURL(List&lt;String&gt; | null) // nullable authURL
    .addOAuth2GrantTypesSupported|addAllOAuth2GrantTypesSupported(com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth.OAuth2GrantType) // oAuth2GrantTypesSupported elements
    .oAuth2ContentType(com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth.OAuth2ContentType) // optional oAuth2ContentType
    .oAuth2MethodType(com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth.OAuth2MethodType) // optional oAuth2MethodType
    .oauth2CustomProperties(List&lt;com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth.OAuth2CustomParameter&gt; | null) // nullable oauth2CustomProperties
    .addBasicAuthHeader(boolean) // optional addBasicAuthHeader
    .build();
 
```
    Returns:
    
    A new ImmutableOAuth2Defaults builder

Class ImmutableOAuth2Defaults

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

oAuthScopes

tokenURL

authURL

oAuth2GrantTypesSupported

oAuth2ContentType

oAuth2MethodType

oauth2CustomProperties

addBasicAuthHeader

withOAuthScopes

withOAuthScopes

withTokenURL

withTokenURL

withAuthURL

withAuthURL

withOAuth2GrantTypesSupported

withOAuth2GrantTypesSupported

withOAuth2ContentType

withOAuth2MethodType

withOauth2CustomProperties

withOauth2CustomProperties

withAddBasicAuthHeader

equals

hashCode

toString

copyOf

builder