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

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

All Implemented Interfaces:: AuthParameter

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

Immutable implementation of AuthParameter.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableAuthParameter.Builder
Builds instances of type ImmutableAuthParameter.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableAuthParameter.Builder`	`builder()` Creates a builder for `ImmutableAuthParameter`.
`com.google.common.collect.ImmutableList<String>`	`connectorSuppliedValues()` Values provided by connector which can be used as input for this AuthParameter.
`static ImmutableAuthParameter`	`copyOf(AuthParameter instance)` Creates an immutable copy of a `AuthParameter` value.
`String`	`description()` Description of the Auth Parameter.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableAuthParameter` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `key`, `required`, `label`, `description`, `sensitiveField`, `connectorSuppliedValues`.
`String`	`key()` Unique identifier for AuthParameter.
`String`	`label()` Label of the Auth Parameter.
`boolean`	`required()` Specifies if this AuthParameter is required or not.
`Boolean`	`sensitiveField()` Specifies if this field data is sensitive/Critical that shouldn't be stored as plain text.
`String`	`toString()` Prints the immutable value `AuthParameter` with attribute values.
`ImmutableAuthParameter`	`withConnectorSuppliedValues(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `connectorSuppliedValues`.
`ImmutableAuthParameter`	`withConnectorSuppliedValues(String... elements)` Copy the current immutable object with elements that replace the content of `connectorSuppliedValues`.
`ImmutableAuthParameter`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableAuthParameter`	`withKey(String value)` Copy the current immutable object by setting a value for the `key` attribute.
`ImmutableAuthParameter`	`withLabel(String value)` Copy the current immutable object by setting a value for the `label` attribute.
`ImmutableAuthParameter`	`withRequired(boolean value)` Copy the current immutable object by setting a value for the `required` attribute.
`ImmutableAuthParameter`	`withSensitiveField(Boolean value)` Copy the current immutable object by setting a value for the `sensitiveField` 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 AuthParameter.
    
    Specified by:
    
    key in interface AuthParameter
  - required
```
public boolean required()
```
    Specifies if this AuthParameter is required or not.
    
    Specified by:
    
    required in interface AuthParameter
  - label
```
public String label()
```
    Label of the Auth Parameter.
    
    Specified by:
    
    label in interface AuthParameter
  - description
```
public String description()
```
    Description of the Auth Parameter.
    
    Specified by:
    
    description in interface AuthParameter
  - sensitiveField
```
@Nullable
public Boolean sensitiveField()
```
    Specifies if this field data is sensitive/Critical that shouldn't be stored as plain text.
    
    Specified by:
    
    sensitiveField in interface AuthParameter
  - connectorSuppliedValues
```
@Nullable
public com.google.common.collect.ImmutableList<String> connectorSuppliedValues()
```
    Values provided by connector which can be used as input for this AuthParameter.
    
    Specified by:
    
    connectorSuppliedValues in interface AuthParameter
  - withKey
```
public final ImmutableAuthParameter 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
  - withRequired
```
public final ImmutableAuthParameter 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 ImmutableAuthParameter 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 ImmutableAuthParameter 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
  - withSensitiveField
```
public final ImmutableAuthParameter withSensitiveField(@Nullable
                                                       Boolean value)
```
    Copy the current immutable object by setting a value for the sensitiveField attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for sensitiveField (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withConnectorSuppliedValues
```
public final ImmutableAuthParameter withConnectorSuppliedValues(@Nullable
                                                                String... elements)
```
    Copy the current immutable object with elements that replace the content of connectorSuppliedValues.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withConnectorSuppliedValues
```
public final ImmutableAuthParameter withConnectorSuppliedValues(@Nullable
                                                                Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of connectorSuppliedValues. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of connectorSuppliedValues 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 ImmutableAuthParameter 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, required, label, description, sensitiveField, connectorSuppliedValues.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value AuthParameter with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableAuthParameter copyOf(AuthParameter instance)
```
    Creates an immutable copy of a AuthParameter 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 AuthParameter instance
  - builder
```
public static ImmutableAuthParameter.Builder builder()
```
    Creates a builder for ImmutableAuthParameter.
```
 ImmutableAuthParameter.builder()
    .key(String) // required key
    .required(boolean) // required required
    .label(String) // required label
    .description(String) // required description
    .sensitiveField(Boolean | null) // nullable sensitiveField
    .connectorSuppliedValues(List&lt;String&gt; | null) // nullable connectorSuppliedValues
    .build();
 
```
    Returns:
    
    A new ImmutableAuthParameter builder

Class ImmutableAuthParameter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

key

required

label

description

sensitiveField

connectorSuppliedValues

withKey

withRequired

withLabel

withDescription

withSensitiveField

withConnectorSuppliedValues

withConnectorSuppliedValues

equals

hashCode

toString

copyOf

builder