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

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

All Implemented Interfaces:: AuthenticationConfig

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

Immutable implementation of AuthenticationConfig.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableAuthenticationConfig.Builder
Builds instances of type ImmutableAuthenticationConfig.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableAuthenticationConfig.Builder`	`builder()` Creates a builder for `ImmutableAuthenticationConfig`.
`static ImmutableAuthenticationConfig`	`copyOf(AuthenticationConfig instance)` Creates an immutable copy of a `AuthenticationConfig` value.
`com.google.common.collect.ImmutableList<CustomAuthConfig>`	`customAuthConfig()` Configuration for custom Authentication defined by the connector.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableAuthenticationConfig` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `isBasicAuthSupported`, `isApiKeyAuthSupported`, `isOAuth2Supported`, `isCustomAuthSupported`, `oAuth2Defaults`, `customAuthConfig`.
`Boolean`	`isApiKeyAuthSupported()` Specifies if the ApiKey Auth is supported by connector.
`Boolean`	`isBasicAuthSupported()` Specifies if the Basic Auth is supported by connector.
`Boolean`	`isCustomAuthSupported()` Specifies if the Custom Authentication is supported by connector.
`Boolean`	`isOAuth2Supported()` Specifies if the OAuth2 is supported by connector.
`OAuth2Defaults`	`oAuth2Defaults()` OAuth2 default values provided by the connector.
`String`	`toString()` Prints the immutable value `AuthenticationConfig` with attribute values.
`ImmutableAuthenticationConfig`	`withCustomAuthConfig(CustomAuthConfig... elements)` Copy the current immutable object with elements that replace the content of `customAuthConfig`.
`ImmutableAuthenticationConfig`	`withCustomAuthConfig(Iterable<? extends CustomAuthConfig> elements)` Copy the current immutable object with elements that replace the content of `customAuthConfig`.
`ImmutableAuthenticationConfig`	`withIsApiKeyAuthSupported(Boolean value)` Copy the current immutable object by setting a value for the `isApiKeyAuthSupported` attribute.
`ImmutableAuthenticationConfig`	`withIsBasicAuthSupported(Boolean value)` Copy the current immutable object by setting a value for the `isBasicAuthSupported` attribute.
`ImmutableAuthenticationConfig`	`withIsCustomAuthSupported(Boolean value)` Copy the current immutable object by setting a value for the `isCustomAuthSupported` attribute.
`ImmutableAuthenticationConfig`	`withIsOAuth2Supported(Boolean value)` Copy the current immutable object by setting a value for the `isOAuth2Supported` attribute.
`ImmutableAuthenticationConfig`	`withOAuth2Defaults(OAuth2Defaults value)` Copy the current immutable object by setting a value for the `oAuth2Defaults` attribute.

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

- Method Detail
  - isBasicAuthSupported
```
@Nullable
public Boolean isBasicAuthSupported()
```
    Specifies if the Basic Auth is supported by connector.
    
    Specified by:
    
    isBasicAuthSupported in interface AuthenticationConfig
  - isApiKeyAuthSupported
```
@Nullable
public Boolean isApiKeyAuthSupported()
```
    Specifies if the ApiKey Auth is supported by connector.
    
    Specified by:
    
    isApiKeyAuthSupported in interface AuthenticationConfig
  - isOAuth2Supported
```
@Nullable
public Boolean isOAuth2Supported()
```
    Specifies if the OAuth2 is supported by connector.
    
    Specified by:
    
    isOAuth2Supported in interface AuthenticationConfig
  - isCustomAuthSupported
```
@Nullable
public Boolean isCustomAuthSupported()
```
    Specifies if the Custom Authentication is supported by connector.
    
    Specified by:
    
    isCustomAuthSupported in interface AuthenticationConfig
  - oAuth2Defaults
```
@Nullable
public OAuth2Defaults oAuth2Defaults()
```
    OAuth2 default values provided by the connector.
    
    Specified by:
    
    oAuth2Defaults in interface AuthenticationConfig
  - customAuthConfig
```
@Nullable
public com.google.common.collect.ImmutableList<CustomAuthConfig> customAuthConfig()
```
    Configuration for custom Authentication defined by the connector.
    
    Specified by:
    
    customAuthConfig in interface AuthenticationConfig
  - withIsBasicAuthSupported
```
public final ImmutableAuthenticationConfig withIsBasicAuthSupported(@Nullable
                                                                    Boolean value)
```
    Copy the current immutable object by setting a value for the isBasicAuthSupported attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isBasicAuthSupported (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsApiKeyAuthSupported
```
public final ImmutableAuthenticationConfig withIsApiKeyAuthSupported(@Nullable
                                                                     Boolean value)
```
    Copy the current immutable object by setting a value for the isApiKeyAuthSupported attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isApiKeyAuthSupported (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsOAuth2Supported
```
public final ImmutableAuthenticationConfig withIsOAuth2Supported(@Nullable
                                                                 Boolean value)
```
    Copy the current immutable object by setting a value for the isOAuth2Supported attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isOAuth2Supported (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsCustomAuthSupported
```
public final ImmutableAuthenticationConfig withIsCustomAuthSupported(@Nullable
                                                                     Boolean value)
```
    Copy the current immutable object by setting a value for the isCustomAuthSupported attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isCustomAuthSupported (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withOAuth2Defaults
```
public final ImmutableAuthenticationConfig withOAuth2Defaults(@Nullable
                                                              OAuth2Defaults value)
```
    Copy the current immutable object by setting a value for the oAuth2Defaults attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for oAuth2Defaults (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withCustomAuthConfig
```
public final ImmutableAuthenticationConfig withCustomAuthConfig(@Nullable
                                                                CustomAuthConfig... elements)
```
    Copy the current immutable object with elements that replace the content of customAuthConfig.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withCustomAuthConfig
```
public final ImmutableAuthenticationConfig withCustomAuthConfig(@Nullable
                                                                Iterable<? extends CustomAuthConfig> elements)
```
    Copy the current immutable object with elements that replace the content of customAuthConfig. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of customAuthConfig elements to set
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableAuthenticationConfig 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: isBasicAuthSupported, isApiKeyAuthSupported, isOAuth2Supported, isCustomAuthSupported, oAuth2Defaults, customAuthConfig.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value AuthenticationConfig with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableAuthenticationConfig copyOf(AuthenticationConfig instance)
```
    Creates an immutable copy of a AuthenticationConfig 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 AuthenticationConfig instance
  - builder
```
public static ImmutableAuthenticationConfig.Builder builder()
```
    Creates a builder for ImmutableAuthenticationConfig.
```
 ImmutableAuthenticationConfig.builder()
    .isBasicAuthSupported(Boolean | null) // nullable isBasicAuthSupported
    .isApiKeyAuthSupported(Boolean | null) // nullable isApiKeyAuthSupported
    .isOAuth2Supported(Boolean | null) // nullable isOAuth2Supported
    .isCustomAuthSupported(Boolean | null) // nullable isCustomAuthSupported
    .oAuth2Defaults(com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth.OAuth2Defaults | null) // nullable oAuth2Defaults
    .customAuthConfig(List&lt;com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth.CustomAuthConfig&gt; | null) // nullable customAuthConfig
    .build();
 
```
    Returns:
    
    A new ImmutableAuthenticationConfig builder

Class ImmutableAuthenticationConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isBasicAuthSupported

isApiKeyAuthSupported

isOAuth2Supported

isCustomAuthSupported

oAuth2Defaults

customAuthConfig

withIsBasicAuthSupported

withIsApiKeyAuthSupported

withIsOAuth2Supported

withIsCustomAuthSupported

withOAuth2Defaults

withCustomAuthConfig

withCustomAuthConfig

equals

hashCode

toString

copyOf

builder