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

java.lang.Object
- com.amazonaws.appflow.custom.connector.model.query.ImmutableQueryDataRequest

All Implemented Interfaces:: ConnectorRequest, QueryDataRequest, AutoCloseable

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

Immutable implementation of QueryDataRequest.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableQueryDataRequest.Builder
Builds instances of type ImmutableQueryDataRequest.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableQueryDataRequest.Builder`	`builder()` Creates a builder for `ImmutableQueryDataRequest`.
`ConnectorContext`	`connectorContext()` Context contains the connector settings, credentials and APi version etc.
`static ImmutableQueryDataRequest`	`copyOf(QueryDataRequest instance)` Creates an immutable copy of a `QueryDataRequest` value.
`String`	`entityIdentifier()` Unique identifier for the entity.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableQueryDataRequest` that have equal attribute values.
`String`	`filterExpression()` Filter expression string similar to the WHERE clause in SQL.
`int`	`hashCode()` Computes a hash code from attributes: `entityIdentifier`, `selectedFieldNames`, `filterExpression`, `maxResults`, `nextToken`, `connectorContext`.
`Long`	`maxResults()` Maximum number of records needs to be returned as part of single call.
`String`	`nextToken()` The pagination token - next page should start from this token value.
`List<String>`	`selectedFieldNames()` Field values to retrieve.
`String`	`toString()` Prints the immutable value `QueryDataRequest` with attribute values.
`ImmutableQueryDataRequest`	`withConnectorContext(ConnectorContext value)` Copy the current immutable object by setting a value for the `connectorContext` attribute.
`ImmutableQueryDataRequest`	`withEntityIdentifier(String value)` Copy the current immutable object by setting a value for the `entityIdentifier` attribute.
`ImmutableQueryDataRequest`	`withFilterExpression(String value)` Copy the current immutable object by setting a value for the `filterExpression` attribute.
`ImmutableQueryDataRequest`	`withMaxResults(Long value)` Copy the current immutable object by setting a value for the `maxResults` attribute.
`ImmutableQueryDataRequest`	`withNextToken(String value)` Copy the current immutable object by setting a value for the `nextToken` attribute.
`ImmutableQueryDataRequest`	`withSelectedFieldNames(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `selectedFieldNames`.
`ImmutableQueryDataRequest`	`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 QueryDataRequest
  - 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 QueryDataRequest
  - filterExpression
```
@Nullable
public String filterExpression()
```
    Filter expression string similar to the WHERE clause in SQL.
    
    Specified by:
    
    filterExpression in interface QueryDataRequest
  - maxResults
```
public Long maxResults()
```
    Maximum number of records needs to be returned as part of single call. Default value is 1000.
    
    Specified by:
    
    maxResults in interface QueryDataRequest
  - nextToken
```
@Nullable
public String nextToken()
```
    The pagination token - next page should start from this token value.
    
    Specified by:
    
    nextToken in interface QueryDataRequest
  - connectorContext
```
public ConnectorContext connectorContext()
```
    Context contains the connector settings, credentials and APi version etc.
    
    Specified by:
    
    connectorContext in interface QueryDataRequest
  - withEntityIdentifier
```
public final ImmutableQueryDataRequest 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 ImmutableQueryDataRequest 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 ImmutableQueryDataRequest 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
  - withFilterExpression
```
public final ImmutableQueryDataRequest withFilterExpression(@Nullable
                                                            String value)
```
    Copy the current immutable object by setting a value for the filterExpression attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for filterExpression (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withMaxResults
```
public final ImmutableQueryDataRequest withMaxResults(Long value)
```
    Copy the current immutable object by setting a value for the maxResults attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for maxResults
    
    Returns:
    
    A modified copy of the this object
  - withNextToken
```
public final ImmutableQueryDataRequest withNextToken(@Nullable
                                                     String value)
```
    Copy the current immutable object by setting a value for the nextToken attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for nextToken (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withConnectorContext
```
public final ImmutableQueryDataRequest 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 ImmutableQueryDataRequest 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, filterExpression, maxResults, nextToken, connectorContext.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value QueryDataRequest with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableQueryDataRequest copyOf(QueryDataRequest instance)
```
    Creates an immutable copy of a QueryDataRequest 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 QueryDataRequest instance
  - builder
```
public static ImmutableQueryDataRequest.Builder builder()
```
    Creates a builder for ImmutableQueryDataRequest.
```
 ImmutableQueryDataRequest.builder()
    .entityIdentifier(String) // required entityIdentifier
    .selectedFieldNames(List&lt;String&gt; | null) // nullable selectedFieldNames
    .filterExpression(String | null) // nullable filterExpression
    .maxResults(Long) // optional maxResults
    .nextToken(String | null) // nullable nextToken
    .connectorContext(com.amazonaws.appflow.custom.connector.model.ConnectorContext) // required connectorContext
    .build();
 
```
    Returns:
    
    A new ImmutableQueryDataRequest builder

Class ImmutableQueryDataRequest

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

filterExpression

maxResults

nextToken

connectorContext

withEntityIdentifier

withSelectedFieldNames

withSelectedFieldNames

withFilterExpression

withMaxResults

withNextToken

withConnectorContext

equals

hashCode

toString

copyOf

builder