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

java.lang.Object
- com.amazonaws.appflow.custom.connector.model.metadata.ImmutableFieldDefinition

All Implemented Interfaces:: FieldDefinition

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

Immutable implementation of FieldDefinition.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableFieldDefinition.Builder
Builds instances of type ImmutableFieldDefinition.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableFieldDefinition.Builder`	`builder()` Creates a builder for `ImmutableFieldDefinition`.
`FieldConstraints`	`constraints()` Constraints applicable to this field like length, value etc.
`static ImmutableFieldDefinition`	`copyOf(FieldDefinition instance)` Creates an immutable copy of a `FieldDefinition` value.
`com.google.common.collect.ImmutableMap<String,String>`	`customProperties()` Custom properties defined for this field.
`FieldDataType`	`dataType()` DataType of this field.
`String`	`dataTypeLabel()` Application specific description of the dataType, so that AppFlow user can be presented with the same information in the public API for exposing connector specific metadata
`String`	`defaultValue()` Default value of the field.
`String`	`description()` Description of this field.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableFieldDefinition` that have equal attribute values.
`String`	`fieldName()` The unique identifier of the connector field.
`com.google.common.collect.ImmutableList<ConnectorOperator>`	`filterOperators()` Filter Operators applicable for this field.
`int`	`hashCode()` Computes a hash code from attributes: `fieldName`, `dataType`, `dataTypeLabel`, `label`, `description`, `isPrimaryKey`, `defaultValue`, `isDeprecated`, `constraints`, `readProperties`, `writeProperties`, `filterOperators`, `customProperties`.
`Boolean`	`isDeprecated()` Specifies if this field is deprecated.
`Boolean`	`isPrimaryKey()` Specifies if it can be used as a primary key.
`String`	`label()` Label for this field.
`ReadOperationProperty`	`readProperties()` The properties that can be applied to a field when the connector is being used as a SOURCE.
`String`	`toString()` Prints the immutable value `FieldDefinition` with attribute values.
`ImmutableFieldDefinition`	`withConstraints(FieldConstraints value)` Copy the current immutable object by setting a value for the `constraints` attribute.
`ImmutableFieldDefinition`	`withCustomProperties(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `customProperties` map with the specified map.
`ImmutableFieldDefinition`	`withDataType(FieldDataType value)` Copy the current immutable object by setting a value for the `dataType` attribute.
`ImmutableFieldDefinition`	`withDataTypeLabel(String value)` Copy the current immutable object by setting a value for the `dataTypeLabel` attribute.
`ImmutableFieldDefinition`	`withDefaultValue(String value)` Copy the current immutable object by setting a value for the `defaultValue` attribute.
`ImmutableFieldDefinition`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableFieldDefinition`	`withFieldName(String value)` Copy the current immutable object by setting a value for the `fieldName` attribute.
`ImmutableFieldDefinition`	`withFilterOperators(ConnectorOperator... elements)` Copy the current immutable object with elements that replace the content of `filterOperators`.
`ImmutableFieldDefinition`	`withFilterOperators(Iterable<? extends ConnectorOperator> elements)` Copy the current immutable object with elements that replace the content of `filterOperators`.
`ImmutableFieldDefinition`	`withIsDeprecated(Boolean value)` Copy the current immutable object by setting a value for the `isDeprecated` attribute.
`ImmutableFieldDefinition`	`withIsPrimaryKey(Boolean value)` Copy the current immutable object by setting a value for the `isPrimaryKey` attribute.
`ImmutableFieldDefinition`	`withLabel(String value)` Copy the current immutable object by setting a value for the `label` attribute.
`ImmutableFieldDefinition`	`withReadProperties(ReadOperationProperty value)` Copy the current immutable object by setting a value for the `readProperties` attribute.
`ImmutableFieldDefinition`	`withWriteProperties(WriteOperationProperty value)` Copy the current immutable object by setting a value for the `writeProperties` attribute.
`WriteOperationProperty`	`writeProperties()` The properties applied to a field when the connector is being used as a destination.

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

- Method Detail
  - fieldName
```
public String fieldName()
```
    The unique identifier of the connector field.
    
    Specified by:
    
    fieldName in interface FieldDefinition
  - dataType
```
public FieldDataType dataType()
```
    DataType of this field.
    
    Specified by:
    
    dataType in interface FieldDefinition
  - dataTypeLabel
```
public String dataTypeLabel()
```
    Application specific description of the dataType, so that AppFlow user can be presented with the same information in the public API for exposing connector specific metadata
    
    Specified by:
    
    dataTypeLabel in interface FieldDefinition
  - label
```
@Nullable
public String label()
```
    Label for this field.
    
    Specified by:
    
    label in interface FieldDefinition
  - description
```
@Nullable
public String description()
```
    Description of this field.
    
    Specified by:
    
    description in interface FieldDefinition
  - isPrimaryKey
```
@Nullable
public Boolean isPrimaryKey()
```
    Specifies if it can be used as a primary key.
    
    Specified by:
    
    isPrimaryKey in interface FieldDefinition
  - defaultValue
```
@Nullable
public String defaultValue()
```
    Default value of the field.
    
    Specified by:
    
    defaultValue in interface FieldDefinition
  - isDeprecated
```
@Nullable
public Boolean isDeprecated()
```
    Specifies if this field is deprecated.
    
    Specified by:
    
    isDeprecated in interface FieldDefinition
  - constraints
```
@Nullable
public FieldConstraints constraints()
```
    Constraints applicable to this field like length, value etc.
    
    Specified by:
    
    constraints in interface FieldDefinition
  - readProperties
```
@Nullable
public ReadOperationProperty readProperties()
```
    The properties that can be applied to a field when the connector is being used as a SOURCE.
    
    Specified by:
    
    readProperties in interface FieldDefinition
  - writeProperties
```
@Nullable
public WriteOperationProperty writeProperties()
```
    The properties applied to a field when the connector is being used as a destination.
    
    Specified by:
    
    writeProperties in interface FieldDefinition
  - filterOperators
```
public com.google.common.collect.ImmutableList<ConnectorOperator> filterOperators()
```
    Filter Operators applicable for this field. This method can be overridden by the connector developers for specific use cases. For example if they wish to disallow certain operators for specific data types, that can be modified by overriding this method.
    
    Specified by:
    
    filterOperators in interface FieldDefinition
  - customProperties
```
@Nullable
public com.google.common.collect.ImmutableMap<String,String> customProperties()
```
    Custom properties defined for this field.
    
    Specified by:
    
    customProperties in interface FieldDefinition
  - withFieldName
```
public final ImmutableFieldDefinition withFieldName(String value)
```
    Copy the current immutable object by setting a value for the fieldName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for fieldName
    
    Returns:
    
    A modified copy of the this object
  - withDataType
```
public final ImmutableFieldDefinition withDataType(FieldDataType 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
  - withDataTypeLabel
```
public final ImmutableFieldDefinition withDataTypeLabel(String value)
```
    Copy the current immutable object by setting a value for the dataTypeLabel attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for dataTypeLabel
    
    Returns:
    
    A modified copy of the this object
  - withLabel
```
public final ImmutableFieldDefinition withLabel(@Nullable
                                                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 (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withDescription
```
public final ImmutableFieldDefinition withDescription(@Nullable
                                                      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 (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsPrimaryKey
```
public final ImmutableFieldDefinition withIsPrimaryKey(@Nullable
                                                       Boolean value)
```
    Copy the current immutable object by setting a value for the isPrimaryKey attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isPrimaryKey (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withDefaultValue
```
public final ImmutableFieldDefinition withDefaultValue(@Nullable
                                                       String value)
```
    Copy the current immutable object by setting a value for the defaultValue attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for defaultValue (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsDeprecated
```
public final ImmutableFieldDefinition withIsDeprecated(@Nullable
                                                       Boolean value)
```
    Copy the current immutable object by setting a value for the isDeprecated attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isDeprecated (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withConstraints
```
public final ImmutableFieldDefinition withConstraints(@Nullable
                                                      FieldConstraints value)
```
    Copy the current immutable object by setting a value for the constraints attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for constraints (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withReadProperties
```
public final ImmutableFieldDefinition withReadProperties(@Nullable
                                                         ReadOperationProperty value)
```
    Copy the current immutable object by setting a value for the readProperties attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for readProperties (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withWriteProperties
```
public final ImmutableFieldDefinition withWriteProperties(@Nullable
                                                          WriteOperationProperty value)
```
    Copy the current immutable object by setting a value for the writeProperties attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for writeProperties (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withFilterOperators
```
public final ImmutableFieldDefinition withFilterOperators(ConnectorOperator... elements)
```
    Copy the current immutable object with elements that replace the content of filterOperators.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withFilterOperators
```
public final ImmutableFieldDefinition withFilterOperators(Iterable<? extends ConnectorOperator> elements)
```
    Copy the current immutable object with elements that replace the content of filterOperators. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of filterOperators elements to set
    
    Returns:
    
    A modified copy of this object
  - withCustomProperties
```
public final ImmutableFieldDefinition withCustomProperties(@Nullable
                                                           Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the customProperties 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 customProperties map
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableFieldDefinition 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: fieldName, dataType, dataTypeLabel, label, description, isPrimaryKey, defaultValue, isDeprecated, constraints, readProperties, writeProperties, filterOperators, customProperties.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value FieldDefinition with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableFieldDefinition copyOf(FieldDefinition instance)
```
    Creates an immutable copy of a FieldDefinition 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 FieldDefinition instance
  - builder
```
public static ImmutableFieldDefinition.Builder builder()
```
    Creates a builder for ImmutableFieldDefinition.
```
 ImmutableFieldDefinition.builder()
    .fieldName(String) // required fieldName
    .dataType(com.amazonaws.appflow.custom.connector.model.metadata.FieldDataType) // required dataType
    .dataTypeLabel(String) // optional dataTypeLabel
    .label(String | null) // nullable label
    .description(String | null) // nullable description
    .isPrimaryKey(Boolean | null) // nullable isPrimaryKey
    .defaultValue(String | null) // nullable defaultValue
    .isDeprecated(Boolean | null) // nullable isDeprecated
    .constraints(com.amazonaws.appflow.custom.connector.model.metadata.FieldConstraints | null) // nullable constraints
    .readProperties(com.amazonaws.appflow.custom.connector.model.metadata.ReadOperationProperty | null) // nullable readProperties
    .writeProperties(com.amazonaws.appflow.custom.connector.model.metadata.WriteOperationProperty | null) // nullable writeProperties
    .addFilterOperators|addAllFilterOperators(com.amazonaws.appflow.custom.connector.model.connectorconfiguration.ConnectorOperator) // filterOperators elements
    .customProperties(Map&lt;String, String&gt; | null) // nullable customProperties
    .build();
 
```
    Returns:
    
    A new ImmutableFieldDefinition builder

Class ImmutableFieldDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fieldName

dataType

dataTypeLabel

label

description

isPrimaryKey

defaultValue

isDeprecated

constraints

readProperties

writeProperties

filterOperators

customProperties

withFieldName

withDataType

withDataTypeLabel

withLabel

withDescription

withIsPrimaryKey

withDefaultValue

withIsDeprecated

withConstraints

withReadProperties

withWriteProperties

withFilterOperators

withFilterOperators

withCustomProperties

equals

hashCode

toString

copyOf

builder