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

java.lang.Object
- com.amazonaws.appflow.custom.connector.model.settings.ImmutableConnectorRuntimeSetting

All Implemented Interfaces:: ConnectorRuntimeSetting

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

Immutable implementation of ConnectorRuntimeSetting.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableConnectorRuntimeSetting.Builder
Builds instances of type ImmutableConnectorRuntimeSetting.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableConnectorRuntimeSetting.Builder`	`builder()` Creates a builder for `ImmutableConnectorRuntimeSetting`.
`com.google.common.collect.ImmutableList<String>`	`connectorSuppliedValueOptions()` Optional connector supplied value options (with matching data type) that the user can pick from as a value for this runtime setting.
`static ImmutableConnectorRuntimeSetting`	`copyOf(ConnectorRuntimeSetting instance)` Creates an immutable copy of a `ConnectorRuntimeSetting` value.
`ConnectorRuntimeSettingDataType`	`dataType()` Data type for the connector runtime setting.
`String`	`description()` Description of the connector runtime setting.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableConnectorRuntimeSetting` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `key`, `dataType`, `required`, `label`, `description`, `scope`, `connectorSuppliedValueOptions`.
`String`	`key()` Unique identifier for the connector runtime setting.
`String`	`label()` Label for the connector runtime setting.
`boolean`	`required()` Specifies if this setting is required or not.
`ConnectorRuntimeSettingScope`	`scope()` Scope of the runtime setting needed for CONNECTOR_PROFILE, SOURCE, DESTINATION etc.
`String`	`toString()` Prints the immutable value `ConnectorRuntimeSetting` with attribute values.
`ImmutableConnectorRuntimeSetting`	`withConnectorSuppliedValueOptions(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `connectorSuppliedValueOptions`.
`ImmutableConnectorRuntimeSetting`	`withConnectorSuppliedValueOptions(String... elements)` Copy the current immutable object with elements that replace the content of `connectorSuppliedValueOptions`.
`ImmutableConnectorRuntimeSetting`	`withDataType(ConnectorRuntimeSettingDataType value)` Copy the current immutable object by setting a value for the `dataType` attribute.
`ImmutableConnectorRuntimeSetting`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableConnectorRuntimeSetting`	`withKey(String value)` Copy the current immutable object by setting a value for the `key` attribute.
`ImmutableConnectorRuntimeSetting`	`withLabel(String value)` Copy the current immutable object by setting a value for the `label` attribute.
`ImmutableConnectorRuntimeSetting`	`withRequired(boolean value)` Copy the current immutable object by setting a value for the `required` attribute.
`ImmutableConnectorRuntimeSetting`	`withScope(ConnectorRuntimeSettingScope value)` Copy the current immutable object by setting a value for the `scope` attribute.

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

- Method Detail
  - key
```
public String key()
```
    Unique identifier for the connector runtime setting.
    
    Specified by:
    
    key in interface ConnectorRuntimeSetting
  - dataType
```
public ConnectorRuntimeSettingDataType dataType()
```
    Data type for the connector runtime setting.
    
    Specified by:
    
    dataType in interface ConnectorRuntimeSetting
  - required
```
public boolean required()
```
    Specifies if this setting is required or not.
    
    Specified by:
    
    required in interface ConnectorRuntimeSetting
  - label
```
public String label()
```
    Label for the connector runtime setting.
    
    Specified by:
    
    label in interface ConnectorRuntimeSetting
  - description
```
public String description()
```
    Description of the connector runtime setting.
    
    Specified by:
    
    description in interface ConnectorRuntimeSetting
  - scope
```
public ConnectorRuntimeSettingScope scope()
```
    Scope of the runtime setting needed for CONNECTOR_PROFILE, SOURCE, DESTINATION etc.
    
    Specified by:
    
    scope in interface ConnectorRuntimeSetting
  - connectorSuppliedValueOptions
```
@Nullable
public com.google.common.collect.ImmutableList<String> connectorSuppliedValueOptions()
```
    Optional connector supplied value options (with matching data type) that the user can pick from as a value for this runtime setting.
    
    Specified by:
    
    connectorSuppliedValueOptions in interface ConnectorRuntimeSetting
  - withKey
```
public final ImmutableConnectorRuntimeSetting withKey(String value)
```
    Copy the current immutable object by setting a value for the key attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for key
    
    Returns:
    
    A modified copy of the this object
  - withDataType
```
public final ImmutableConnectorRuntimeSetting withDataType(ConnectorRuntimeSettingDataType value)
```
    Copy the current immutable object by setting a value for the dataType attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for dataType
    
    Returns:
    
    A modified copy of the this object
  - withRequired
```
public final ImmutableConnectorRuntimeSetting withRequired(boolean value)
```
    Copy the current immutable object by setting a value for the required attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for required
    
    Returns:
    
    A modified copy of the this object
  - withLabel
```
public final ImmutableConnectorRuntimeSetting withLabel(String value)
```
    Copy the current immutable object by setting a value for the label attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for label
    
    Returns:
    
    A modified copy of the this object
  - withDescription
```
public final ImmutableConnectorRuntimeSetting withDescription(String value)
```
    Copy the current immutable object by setting a value for the description attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for description
    
    Returns:
    
    A modified copy of the this object
  - withScope
```
public final ImmutableConnectorRuntimeSetting withScope(ConnectorRuntimeSettingScope value)
```
    Copy the current immutable object by setting a value for the scope attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for scope
    
    Returns:
    
    A modified copy of the this object
  - withConnectorSuppliedValueOptions
```
public final ImmutableConnectorRuntimeSetting withConnectorSuppliedValueOptions(@Nullable
                                                                                String... elements)
```
    Copy the current immutable object with elements that replace the content of connectorSuppliedValueOptions.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withConnectorSuppliedValueOptions
```
public final ImmutableConnectorRuntimeSetting withConnectorSuppliedValueOptions(@Nullable
                                                                                Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of connectorSuppliedValueOptions. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of connectorSuppliedValueOptions 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 ImmutableConnectorRuntimeSetting 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: key, dataType, required, label, description, scope, connectorSuppliedValueOptions.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value ConnectorRuntimeSetting with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableConnectorRuntimeSetting copyOf(ConnectorRuntimeSetting instance)
```
    Creates an immutable copy of a ConnectorRuntimeSetting 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 ConnectorRuntimeSetting instance
  - builder
```
public static ImmutableConnectorRuntimeSetting.Builder builder()
```
    Creates a builder for ImmutableConnectorRuntimeSetting.
```
 ImmutableConnectorRuntimeSetting.builder()
    .key(String) // required key
    .dataType(com.amazonaws.appflow.custom.connector.model.settings.ConnectorRuntimeSettingDataType) // required dataType
    .required(boolean) // required required
    .label(String) // required label
    .description(String) // required description
    .scope(com.amazonaws.appflow.custom.connector.model.settings.ConnectorRuntimeSettingScope) // required scope
    .connectorSuppliedValueOptions(List&lt;String&gt; | null) // nullable connectorSuppliedValueOptions
    .build();
 
```
    Returns:
    
    A new ImmutableConnectorRuntimeSetting builder

Class ImmutableConnectorRuntimeSetting

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

key

dataType

required

label

description

scope

connectorSuppliedValueOptions

withKey

withDataType

withRequired

withLabel

withDescription

withScope

withConnectorSuppliedValueOptions

withConnectorSuppliedValueOptions

equals

hashCode

toString

copyOf

builder