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

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

All Implemented Interfaces:: WriteOperationProperty

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

Immutable implementation of WriteOperationProperty.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableWriteOperationProperty.Builder
Builds instances of type ImmutableWriteOperationProperty.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableWriteOperationProperty.Builder`	`builder()` Creates a builder for `ImmutableWriteOperationProperty`.
`static ImmutableWriteOperationProperty`	`copyOf(WriteOperationProperty instance)` Creates an immutable copy of a `WriteOperationProperty` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableWriteOperationProperty` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `isCreatable`, `isUpdatable`, `isNullable`, `isUpsertable`, `isDefaultedOnCreate`, `supportedWriteOperations`.
`Boolean`	`isCreatable()` Specifies if the destination field can be created by the current user.
`Boolean`	`isDefaultedOnCreate()` Specifies if default value will be used by application while creating records if not provided.
`Boolean`	`isNullable()` Specifies if the destination field can have a null value.
`Boolean`	`isUpdatable()` Specifies whether the field can be updated during an UPDATE or UPSERT write operation.
`Boolean`	`isUpsertable()` Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
`com.google.common.collect.ImmutableList<WriteOperationType>`	`supportedWriteOperations()` A list of supported write operations.
`String`	`toString()` Prints the immutable value `WriteOperationProperty` with attribute values.
`ImmutableWriteOperationProperty`	`withIsCreatable(Boolean value)` Copy the current immutable object by setting a value for the `isCreatable` attribute.
`ImmutableWriteOperationProperty`	`withIsDefaultedOnCreate(Boolean value)` Copy the current immutable object by setting a value for the `isDefaultedOnCreate` attribute.
`ImmutableWriteOperationProperty`	`withIsNullable(Boolean value)` Copy the current immutable object by setting a value for the `isNullable` attribute.
`ImmutableWriteOperationProperty`	`withIsUpdatable(Boolean value)` Copy the current immutable object by setting a value for the `isUpdatable` attribute.
`ImmutableWriteOperationProperty`	`withIsUpsertable(Boolean value)` Copy the current immutable object by setting a value for the `isUpsertable` attribute.
`ImmutableWriteOperationProperty`	`withSupportedWriteOperations(Iterable<? extends WriteOperationType> elements)` Copy the current immutable object with elements that replace the content of `supportedWriteOperations`.
`ImmutableWriteOperationProperty`	`withSupportedWriteOperations(WriteOperationType... elements)` Copy the current immutable object with elements that replace the content of `supportedWriteOperations`.

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

- Method Detail
  - isCreatable
```
@Nullable
public Boolean isCreatable()
```
    Specifies if the destination field can be created by the current user.
    
    Specified by:
    
    isCreatable in interface WriteOperationProperty
  - isUpdatable
```
@Nullable
public Boolean isUpdatable()
```
    Specifies whether the field can be updated during an UPDATE or UPSERT write operation.
    
    Specified by:
    
    isUpdatable in interface WriteOperationProperty
  - isNullable
```
@Nullable
public Boolean isNullable()
```
    Specifies if the destination field can have a null value.
    
    Specified by:
    
    isNullable in interface WriteOperationProperty
  - isUpsertable
```
@Nullable
public Boolean isUpsertable()
```
    Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
    
    Specified by:
    
    isUpsertable in interface WriteOperationProperty
  - isDefaultedOnCreate
```
@Nullable
public Boolean isDefaultedOnCreate()
```
    Specifies if default value will be used by application while creating records if not provided.
    
    Specified by:
    
    isDefaultedOnCreate in interface WriteOperationProperty
  - supportedWriteOperations
```
@Nullable
public com.google.common.collect.ImmutableList<WriteOperationType> supportedWriteOperations()
```
    A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.
    
    Specified by:
    
    supportedWriteOperations in interface WriteOperationProperty
  - withIsCreatable
```
public final ImmutableWriteOperationProperty withIsCreatable(@Nullable
                                                             Boolean value)
```
    Copy the current immutable object by setting a value for the isCreatable attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isCreatable (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsUpdatable
```
public final ImmutableWriteOperationProperty withIsUpdatable(@Nullable
                                                             Boolean value)
```
    Copy the current immutable object by setting a value for the isUpdatable attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isUpdatable (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsNullable
```
public final ImmutableWriteOperationProperty withIsNullable(@Nullable
                                                            Boolean value)
```
    Copy the current immutable object by setting a value for the isNullable attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isNullable (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsUpsertable
```
public final ImmutableWriteOperationProperty withIsUpsertable(@Nullable
                                                              Boolean value)
```
    Copy the current immutable object by setting a value for the isUpsertable attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isUpsertable (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIsDefaultedOnCreate
```
public final ImmutableWriteOperationProperty withIsDefaultedOnCreate(@Nullable
                                                                     Boolean value)
```
    Copy the current immutable object by setting a value for the isDefaultedOnCreate attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isDefaultedOnCreate (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withSupportedWriteOperations
```
public final ImmutableWriteOperationProperty withSupportedWriteOperations(@Nullable
                                                                          WriteOperationType... elements)
```
    Copy the current immutable object with elements that replace the content of supportedWriteOperations.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSupportedWriteOperations
```
public final ImmutableWriteOperationProperty withSupportedWriteOperations(@Nullable
                                                                          Iterable<? extends WriteOperationType> elements)
```
    Copy the current immutable object with elements that replace the content of supportedWriteOperations. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of supportedWriteOperations 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 ImmutableWriteOperationProperty 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: isCreatable, isUpdatable, isNullable, isUpsertable, isDefaultedOnCreate, supportedWriteOperations.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value WriteOperationProperty with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableWriteOperationProperty copyOf(WriteOperationProperty instance)
```
    Creates an immutable copy of a WriteOperationProperty 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 WriteOperationProperty instance
  - builder
```
public static ImmutableWriteOperationProperty.Builder builder()
```
    Creates a builder for ImmutableWriteOperationProperty.
```
 ImmutableWriteOperationProperty.builder()
    .isCreatable(Boolean | null) // nullable isCreatable
    .isUpdatable(Boolean | null) // nullable isUpdatable
    .isNullable(Boolean | null) // nullable isNullable
    .isUpsertable(Boolean | null) // nullable isUpsertable
    .isDefaultedOnCreate(Boolean | null) // nullable isDefaultedOnCreate
    .supportedWriteOperations(List&lt;com.amazonaws.appflow.custom.connector.model.write.WriteOperationType&gt; | null) // nullable supportedWriteOperations
    .build();
 
```
    Returns:
    
    A new ImmutableWriteOperationProperty builder

Class ImmutableWriteOperationProperty

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isCreatable

isUpdatable

isNullable

isUpsertable

isDefaultedOnCreate

supportedWriteOperations

withIsCreatable

withIsUpdatable

withIsNullable

withIsUpsertable

withIsDefaultedOnCreate

withSupportedWriteOperations

withSupportedWriteOperations

equals

hashCode

toString

copyOf

builder