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

java.lang.Object
- com.amazonaws.appflow.custom.connector.model.ImmutableConnectorContext

All Implemented Interfaces:: ConnectorContext

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

Immutable implementation of ConnectorContext.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableConnectorContext.Builder
Builds instances of type ImmutableConnectorContext.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`apiVersion()` API version to use.
`static ImmutableConnectorContext.Builder`	`builder()` Creates a builder for `ImmutableConnectorContext`.
`String`	`connectorProfileLabel()` Connector profile name to use for logging.
`com.google.common.collect.ImmutableMap<String,String>`	`connectorRuntimeSettings()` Connector settings required for API call.
`static ImmutableConnectorContext`	`copyOf(ConnectorContext instance)` Creates an immutable copy of a `ConnectorContext` value.
`Credentials`	`credentials()` Credentials which will be used to make API call.
`EntityDefinition`	`entityDefinition()` Entity definition in compressed form.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableConnectorContext` that have equal attribute values.
`String`	`executionId()` Execution Id to use for logging.
`String`	`flowName()` Flow name to use for logging.
`int`	`hashCode()` Computes a hash code from attributes: `connectorRuntimeSettings`, `credentials`, `apiVersion`, `flowName`, `executionId`, `connectorProfileLabel`, `entityDefinition`.
`String`	`toString()` Prints the immutable value `ConnectorContext` with attribute values.
`ImmutableConnectorContext`	`withApiVersion(String value)` Copy the current immutable object by setting a value for the `apiVersion` attribute.
`ImmutableConnectorContext`	`withConnectorProfileLabel(String value)` Copy the current immutable object by setting a value for the `connectorProfileLabel` attribute.
`ImmutableConnectorContext`	`withConnectorRuntimeSettings(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `connectorRuntimeSettings` map with the specified map.
`ImmutableConnectorContext`	`withCredentials(Credentials value)` Copy the current immutable object by setting a value for the `credentials` attribute.
`ImmutableConnectorContext`	`withEntityDefinition(EntityDefinition value)` Copy the current immutable object by setting a value for the `entityDefinition` attribute.
`ImmutableConnectorContext`	`withExecutionId(String value)` Copy the current immutable object by setting a value for the `executionId` attribute.
`ImmutableConnectorContext`	`withFlowName(String value)` Copy the current immutable object by setting a value for the `flowName` attribute.

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

- Method Detail
  - connectorRuntimeSettings
```
@Nullable
public com.google.common.collect.ImmutableMap<String,String> connectorRuntimeSettings()
```
    Connector settings required for API call. For example, for the Read API it will contains all the ConnectorSettingScope.SOURCE settings. Key will be ConnectorSetting.key() and value will be the input provided by user.
    
    Specified by:
    
    connectorRuntimeSettings in interface ConnectorContext
  - credentials
```
@Nullable
public Credentials credentials()
```
    Credentials which will be used to make API call.
    
    Specified by:
    
    credentials in interface ConnectorContext
  - apiVersion
```
public String apiVersion()
```
    API version to use. Value will be the API Version supported by Connector as part of Connector Configuration.
    
    Specified by:
    
    apiVersion in interface ConnectorContext
  - flowName
```
@Nullable
public String flowName()
```
    Flow name to use for logging.
    
    Specified by:
    
    flowName in interface ConnectorContext
    
    Returns:
  - executionId
```
@Nullable
public String executionId()
```
    Execution Id to use for logging.
    
    Specified by:
    
    executionId in interface ConnectorContext
    
    Returns:
  - connectorProfileLabel
```
@Nullable
public String connectorProfileLabel()
```
    Connector profile name to use for logging.
    
    Specified by:
    
    connectorProfileLabel in interface ConnectorContext
    
    Returns:
  - entityDefinition
```
@Nullable
public EntityDefinition entityDefinition()
```
    Entity definition in compressed form. As it will be required by calling application as well as connector lambda to serialize/deserialize request/response payload.
    
    Specified by:
    
    entityDefinition in interface ConnectorContext
  - withConnectorRuntimeSettings
```
public final ImmutableConnectorContext withConnectorRuntimeSettings(@Nullable
                                                                    Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the connectorRuntimeSettings map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    entries - The entries to be added to the connectorRuntimeSettings map
    
    Returns:
    
    A modified copy of this object
  - withCredentials
```
public final ImmutableConnectorContext withCredentials(@Nullable
                                                       Credentials value)
```
    Copy the current immutable object by setting a value for the credentials attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for credentials (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withApiVersion
```
public final ImmutableConnectorContext withApiVersion(String value)
```
    Copy the current immutable object by setting a value for the apiVersion attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for apiVersion
    
    Returns:
    
    A modified copy of the this object
  - withFlowName
```
public final ImmutableConnectorContext withFlowName(@Nullable
                                                    String value)
```
    Copy the current immutable object by setting a value for the flowName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for flowName (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withExecutionId
```
public final ImmutableConnectorContext withExecutionId(@Nullable
                                                       String value)
```
    Copy the current immutable object by setting a value for the executionId attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for executionId (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withConnectorProfileLabel
```
public final ImmutableConnectorContext withConnectorProfileLabel(@Nullable
                                                                 String value)
```
    Copy the current immutable object by setting a value for the connectorProfileLabel attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for connectorProfileLabel (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withEntityDefinition
```
public final ImmutableConnectorContext withEntityDefinition(@Nullable
                                                            EntityDefinition value)
```
    Copy the current immutable object by setting a value for the entityDefinition attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for entityDefinition (can be null)
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableConnectorContext 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: connectorRuntimeSettings, credentials, apiVersion, flowName, executionId, connectorProfileLabel, entityDefinition.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value ConnectorContext with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableConnectorContext copyOf(ConnectorContext instance)
```
    Creates an immutable copy of a ConnectorContext 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 ConnectorContext instance
  - builder
```
public static ImmutableConnectorContext.Builder builder()
```
    Creates a builder for ImmutableConnectorContext.
```
 ImmutableConnectorContext.builder()
    .connectorRuntimeSettings(Map&lt;String, String&gt; | null) // nullable connectorRuntimeSettings
    .credentials(com.amazonaws.appflow.custom.connector.model.credentials.Credentials | null) // nullable credentials
    .apiVersion(String) // required apiVersion
    .flowName(String | null) // nullable flowName
    .executionId(String | null) // nullable executionId
    .connectorProfileLabel(String | null) // nullable connectorProfileLabel
    .entityDefinition(com.amazonaws.appflow.custom.connector.model.metadata.EntityDefinition | null) // nullable entityDefinition
    .build();
 
```
    Returns:
    
    A new ImmutableConnectorContext builder

Class ImmutableConnectorContext

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

connectorRuntimeSettings

credentials

apiVersion

flowName

executionId

connectorProfileLabel

entityDefinition

withConnectorRuntimeSettings

withCredentials

withApiVersion

withFlowName

withExecutionId

withConnectorProfileLabel

withEntityDefinition

equals

hashCode

toString

copyOf

builder