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

java.lang.Object
- com.amazonaws.appflow.custom.connector.model.write.ImmutableWriteDataRequest

All Implemented Interfaces:: ConnectorRequest, WriteDataRequest, AutoCloseable

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

Immutable implementation of WriteDataRequest.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableWriteDataRequest.Builder
Builds instances of type ImmutableWriteDataRequest.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allOrNone()` Specifies that the WRITE operation must fail immediately after encountering the first instance of failure when writing a batch of records to the Application.
`static ImmutableWriteDataRequest.Builder`	`builder()` Creates a builder for `ImmutableWriteDataRequest`.
`ConnectorContext`	`connectorContext()` Context contains the connector settings, credentials and API version etc.
`static ImmutableWriteDataRequest`	`copyOf(WriteDataRequest instance)` Creates an immutable copy of a `WriteDataRequest` value.
`String`	`entityIdentifier()` Unique identifier for the entity.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableWriteDataRequest` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `entityIdentifier`, `operation`, `idFieldNames`, `records`, `allOrNone`, `connectorContext`.
`List<String>`	`idFieldNames()` Primary keys of the entity.
`WriteOperationType`	`operation()` Write operation type needs to be called.
`List<String>`	`records()` List of JSON serialized string of the entity record as per the entity metadata.
`String`	`toString()` Prints the immutable value `WriteDataRequest` with attribute values.
`ImmutableWriteDataRequest`	`withAllOrNone(Boolean value)` Copy the current immutable object by setting a value for the `allOrNone` attribute.
`ImmutableWriteDataRequest`	`withConnectorContext(ConnectorContext value)` Copy the current immutable object by setting a value for the `connectorContext` attribute.
`ImmutableWriteDataRequest`	`withEntityIdentifier(String value)` Copy the current immutable object by setting a value for the `entityIdentifier` attribute.
`ImmutableWriteDataRequest`	`withIdFieldNames(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `idFieldNames`.
`ImmutableWriteDataRequest`	`withIdFieldNames(String... elements)` Copy the current immutable object with elements that replace the content of `idFieldNames`.
`ImmutableWriteDataRequest`	`withOperation(WriteOperationType value)` Copy the current immutable object by setting a value for the `operation` attribute.
`ImmutableWriteDataRequest`	`withRecords(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `records`.
`ImmutableWriteDataRequest`	`withRecords(String... elements)` Copy the current immutable object with elements that replace the content of `records`.

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

Methods inherited from interface com.amazonaws.appflow.custom.connector.model.ConnectorRequest
close

- Method Detail
  - entityIdentifier
```
public String entityIdentifier()
```
    Unique identifier for the entity. Can be entityId/ entityName / entityPath+name / entityUrl etc.
    
    Specified by:
    
    entityIdentifier in interface WriteDataRequest
  - operation
```
public WriteOperationType operation()
```
    Write operation type needs to be called.
    
    Specified by:
    
    operation in interface WriteDataRequest
  - idFieldNames
```
@Nullable
public List<String> idFieldNames()
```
    Primary keys of the entity. Used for DELETE/ UPDATE/ UPSERT operations.
    
    Specified by:
    
    idFieldNames in interface WriteDataRequest
  - records
```
@Nullable
public List<String> records()
```
    List of JSON serialized string of the entity record as per the entity metadata.
    
    Specified by:
    
    records in interface WriteDataRequest
  - allOrNone
```
@Nullable
public Boolean allOrNone()
```
    Specifies that the WRITE operation must fail immediately after encountering the first instance of failure when writing a batch of records to the Application. Alternatively, if the application supports the allOrNone behavior the connector can pass on the flag to the application.
    
    Specified by:
    
    allOrNone in interface WriteDataRequest
  - connectorContext
```
public ConnectorContext connectorContext()
```
    Context contains the connector settings, credentials and API version etc.
    
    Specified by:
    
    connectorContext in interface WriteDataRequest
  - withEntityIdentifier
```
public final ImmutableWriteDataRequest withEntityIdentifier(String value)
```
    Copy the current immutable object by setting a value for the entityIdentifier attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for entityIdentifier
    
    Returns:
    
    A modified copy of the this object
  - withOperation
```
public final ImmutableWriteDataRequest withOperation(WriteOperationType value)
```
    Copy the current immutable object by setting a value for the operation attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for operation
    
    Returns:
    
    A modified copy of the this object
  - withIdFieldNames
```
public final ImmutableWriteDataRequest withIdFieldNames(@Nullable
                                                        String... elements)
```
    Copy the current immutable object with elements that replace the content of idFieldNames.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withIdFieldNames
```
public final ImmutableWriteDataRequest withIdFieldNames(@Nullable
                                                        Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of idFieldNames. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of idFieldNames elements to set
    
    Returns:
    
    A modified copy of this object
  - withRecords
```
public final ImmutableWriteDataRequest withRecords(@Nullable
                                                   String... elements)
```
    Copy the current immutable object with elements that replace the content of records.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withRecords
```
public final ImmutableWriteDataRequest withRecords(@Nullable
                                                   Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of records. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of records elements to set
    
    Returns:
    
    A modified copy of this object
  - withAllOrNone
```
public final ImmutableWriteDataRequest withAllOrNone(@Nullable
                                                     Boolean value)
```
    Copy the current immutable object by setting a value for the allOrNone attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for allOrNone (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withConnectorContext
```
public final ImmutableWriteDataRequest withConnectorContext(ConnectorContext value)
```
    Copy the current immutable object by setting a value for the connectorContext attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for connectorContext
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableWriteDataRequest 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: entityIdentifier, operation, idFieldNames, records, allOrNone, connectorContext.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value WriteDataRequest with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableWriteDataRequest copyOf(WriteDataRequest instance)
```
    Creates an immutable copy of a WriteDataRequest 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 WriteDataRequest instance
  - builder
```
public static ImmutableWriteDataRequest.Builder builder()
```
    Creates a builder for ImmutableWriteDataRequest.
```
 ImmutableWriteDataRequest.builder()
    .entityIdentifier(String) // required entityIdentifier
    .operation(com.amazonaws.appflow.custom.connector.model.write.WriteOperationType) // required operation
    .idFieldNames(List&lt;String&gt; | null) // nullable idFieldNames
    .records(List&lt;String&gt; | null) // nullable records
    .allOrNone(Boolean | null) // nullable allOrNone
    .connectorContext(com.amazonaws.appflow.custom.connector.model.ConnectorContext) // required connectorContext
    .build();
 
```
    Returns:
    
    A new ImmutableWriteDataRequest builder

Class ImmutableWriteDataRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.appflow.custom.connector.model.ConnectorRequest

Method Detail

entityIdentifier

operation

idFieldNames

records

allOrNone

connectorContext

withEntityIdentifier

withOperation

withIdFieldNames

withIdFieldNames

withRecords

withRecords

withAllOrNone

withConnectorContext

equals

hashCode

toString

copyOf

builder