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

java.lang.Object
- com.amazonaws.appflow.custom.connector.model.retreive.ImmutableRetrieveDataRequest

All Implemented Interfaces:

ConnectorRequest, RetrieveDataRequest, AutoCloseable
```
@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
public final class ImmutableRetrieveDataRequest
extends Object
implements RetrieveDataRequest
```
Immutable implementation of RetrieveDataRequest.
Use the builder to create immutable instances: ImmutableRetrieveDataRequest.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableRetrieveDataRequest.Builder
Builds instances of type ImmutableRetrieveDataRequest.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableRetrieveDataRequest.Builder`	`builder()` Creates a builder for `ImmutableRetrieveDataRequest`.
`ConnectorContext`	`connectorContext()` Context contains the connector settings, credentials and APi version etc.
`static ImmutableRetrieveDataRequest`	`copyOf(RetrieveDataRequest instance)` Creates an immutable copy of a `RetrieveDataRequest` value.
`String`	`entityIdentifier()` Unique identifier for the entity.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableRetrieveDataRequest` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `entityIdentifier`, `selectedFieldNames`, `idFieldName`, `ids`, `connectorContext`.
`String`	`idFieldName()` Field name which will be used as part of where statement to retrieve the data.
`List<String>`	`ids()` List of values for idFieldName.
`List<String>`	`selectedFieldNames()` Field values to retrieve.
`String`	`toString()` Prints the immutable value `RetrieveDataRequest` with attribute values.
`ImmutableRetrieveDataRequest`	`withConnectorContext(ConnectorContext value)` Copy the current immutable object by setting a value for the `connectorContext` attribute.
`ImmutableRetrieveDataRequest`	`withEntityIdentifier(String value)` Copy the current immutable object by setting a value for the `entityIdentifier` attribute.
`ImmutableRetrieveDataRequest`	`withIdFieldName(String value)` Copy the current immutable object by setting a value for the `idFieldName` attribute.
`ImmutableRetrieveDataRequest`	`withIds(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `ids`.
`ImmutableRetrieveDataRequest`	`withIds(String... elements)` Copy the current immutable object with elements that replace the content of `ids`.
`ImmutableRetrieveDataRequest`	`withSelectedFieldNames(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `selectedFieldNames`.
`ImmutableRetrieveDataRequest`	`withSelectedFieldNames(String... elements)` Copy the current immutable object with elements that replace the content of `selectedFieldNames`.

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 RetrieveDataRequest
  - selectedFieldNames
```
@Nullable
public List<String> selectedFieldNames()
```
    Field values to retrieve. If null, it will provide all the fields for the entity.
    
    Specified by:
    
    selectedFieldNames in interface RetrieveDataRequest
  - idFieldName
```
@Nullable
public String idFieldName()
```
    Field name which will be used as part of where statement to retrieve the data. Can be primary or any other column name.
    
    Specified by:
    
    idFieldName in interface RetrieveDataRequest
  - ids
```
@Nullable
public List<String> ids()
```
    List of values for idFieldName.
    
    Specified by:
    
    ids in interface RetrieveDataRequest
  - connectorContext
```
public ConnectorContext connectorContext()
```
    Context contains the connector settings, credentials and APi version etc.
    
    Specified by:
    
    connectorContext in interface RetrieveDataRequest
  - withEntityIdentifier
```
public final ImmutableRetrieveDataRequest 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
  - withSelectedFieldNames
```
public final ImmutableRetrieveDataRequest withSelectedFieldNames(@Nullable
                                                                 String... elements)
```
    Copy the current immutable object with elements that replace the content of selectedFieldNames.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSelectedFieldNames
```
public final ImmutableRetrieveDataRequest withSelectedFieldNames(@Nullable
                                                                 Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of selectedFieldNames. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of selectedFieldNames elements to set
    
    Returns:
    
    A modified copy of this object
  - withIdFieldName
```
public final ImmutableRetrieveDataRequest withIdFieldName(@Nullable
                                                          String value)
```
    Copy the current immutable object by setting a value for the idFieldName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for idFieldName (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withIds
```
public final ImmutableRetrieveDataRequest withIds(@Nullable
                                                  String... elements)
```
    Copy the current immutable object with elements that replace the content of ids.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withIds
```
public final ImmutableRetrieveDataRequest withIds(@Nullable
                                                  Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of ids. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of ids elements to set
    
    Returns:
    
    A modified copy of this object
  - withConnectorContext
```
public final ImmutableRetrieveDataRequest 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 ImmutableRetrieveDataRequest 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, selectedFieldNames, idFieldName, ids, connectorContext.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value RetrieveDataRequest with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableRetrieveDataRequest copyOf(RetrieveDataRequest instance)
```
    Creates an immutable copy of a RetrieveDataRequest 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 RetrieveDataRequest instance
  - builder
```
public static ImmutableRetrieveDataRequest.Builder builder()
```
    Creates a builder for ImmutableRetrieveDataRequest.
```
 ImmutableRetrieveDataRequest.builder()
    .entityIdentifier(String) // required entityIdentifier
    .selectedFieldNames(List&lt;String&gt; | null) // nullable selectedFieldNames
    .idFieldName(String | null) // nullable idFieldName
    .ids(List&lt;String&gt; | null) // nullable ids
    .connectorContext(com.amazonaws.appflow.custom.connector.model.ConnectorContext) // required connectorContext
    .build();
 
```
    Returns:
    
    A new ImmutableRetrieveDataRequest builder

Class ImmutableRetrieveDataRequest

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

selectedFieldNames

idFieldName

ids

connectorContext

withEntityIdentifier

withSelectedFieldNames

withSelectedFieldNames

withIdFieldName

withIds

withIds

withConnectorContext

equals

hashCode

toString

copyOf

builder