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

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

All Implemented Interfaces:: OAuth2CustomParameter

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

Immutable implementation of OAuth2CustomParameter.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableOAuth2CustomParameter.Builder
Builds instances of type ImmutableOAuth2CustomParameter.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableOAuth2CustomParameter.Builder`	`builder()` Creates a builder for `ImmutableOAuth2CustomParameter`.
`com.google.common.collect.ImmutableList<String>`	`connectorSuppliedValues()` Values provided by connector which can be used as input for this AuthParameter.
`static ImmutableOAuth2CustomParameter`	`copyOf(OAuth2CustomParameter instance)` Creates an immutable copy of a `OAuth2CustomParameter` value.
`String`	`description()` Description of the custom Oauth2 parameter.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableOAuth2CustomParameter` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `key`, `required`, `type`, `label`, `description`, `sensitiveField`, `connectorSuppliedValues`.
`String`	`key()` Unique identifier for custom Oauth2 parameter.
`String`	`label()` Label of the custom Oauth2 parameter.
`boolean`	`required()` Specifies if this Oauth2 parameter 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 `OAuth2CustomParameter` with attribute values.
`OAuth2CustomPropType`	`type()` Specifies if this Oauth2 parameter is related to Token Url or Auth Url
`ImmutableOAuth2CustomParameter`	`withConnectorSuppliedValues(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `connectorSuppliedValues`.
`ImmutableOAuth2CustomParameter`	`withConnectorSuppliedValues(String... elements)` Copy the current immutable object with elements that replace the content of `connectorSuppliedValues`.
`ImmutableOAuth2CustomParameter`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableOAuth2CustomParameter`	`withKey(String value)` Copy the current immutable object by setting a value for the `key` attribute.
`ImmutableOAuth2CustomParameter`	`withLabel(String value)` Copy the current immutable object by setting a value for the `label` attribute.
`ImmutableOAuth2CustomParameter`	`withRequired(boolean value)` Copy the current immutable object by setting a value for the `required` attribute.
`ImmutableOAuth2CustomParameter`	`withSensitiveField(Boolean value)` Copy the current immutable object by setting a value for the `sensitiveField` attribute.
`ImmutableOAuth2CustomParameter`	`withType(OAuth2CustomPropType value)` Copy the current immutable object by setting a value for the `type` 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 custom Oauth2 parameter.
    
    Specified by:
    
    key in interface OAuth2CustomParameter
  - required
```
public boolean required()
```
    Specifies if this Oauth2 parameter is required or not.
    
    Specified by:
    
    required in interface OAuth2CustomParameter
  - type
```
public OAuth2CustomPropType type()
```
    Specifies if this Oauth2 parameter is related to Token Url or Auth Url
    
    Specified by:
    
    type in interface OAuth2CustomParameter
  - label
```
public String label()
```
    Label of the custom Oauth2 parameter.
    
    Specified by:
    
    label in interface OAuth2CustomParameter
  - description
```
public String description()
```
    Description of the custom Oauth2 parameter.
    
    Specified by:
    
    description in interface OAuth2CustomParameter
  - 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 OAuth2CustomParameter
  - 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 OAuth2CustomParameter
  - withKey
```
public final ImmutableOAuth2CustomParameter 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 ImmutableOAuth2CustomParameter 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
  - withType
```
public final ImmutableOAuth2CustomParameter withType(OAuth2CustomPropType value)
```
    Copy the current immutable object by setting a value for the type attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for type
    
    Returns:
    
    A modified copy of the this object
  - withLabel
```
public final ImmutableOAuth2CustomParameter 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 ImmutableOAuth2CustomParameter 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 ImmutableOAuth2CustomParameter 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 ImmutableOAuth2CustomParameter 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 ImmutableOAuth2CustomParameter 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 ImmutableOAuth2CustomParameter 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, type, label, description, sensitiveField, connectorSuppliedValues.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value OAuth2CustomParameter with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableOAuth2CustomParameter copyOf(OAuth2CustomParameter instance)
```
    Creates an immutable copy of a OAuth2CustomParameter 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 OAuth2CustomParameter instance
  - builder
```
public static ImmutableOAuth2CustomParameter.Builder builder()
```
    Creates a builder for ImmutableOAuth2CustomParameter.
```
 ImmutableOAuth2CustomParameter.builder()
    .key(String) // required key
    .required(boolean) // required required
    .type(com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth.OAuth2CustomPropType) // required type
    .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 ImmutableOAuth2CustomParameter builder

Class ImmutableOAuth2CustomParameter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

key

required

type

label

description

sensitiveField

connectorSuppliedValues

withKey

withRequired

withType

withLabel

withDescription

withSensitiveField

withConnectorSuppliedValues

withConnectorSuppliedValues

equals

hashCode

toString

copyOf

builder