ImmutableQueryObject (custom-connector-example 1.0 API)

java.lang.Object
- com.amazonaws.appflow.custom.connector.example.query.ImmutableQueryObject

All Implemented Interfaces:: QueryObject

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

Immutable implementation of QueryObject.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableQueryObject.Builder
Builds instances of type ImmutableQueryObject.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableQueryObject.Builder`	`builder()` Creates a builder for `ImmutableQueryObject`.
`static ImmutableQueryObject`	`copyOf(QueryObject instance)` Creates an immutable copy of a `QueryObject` value.
`String`	`dataType()`
`EntityDefinition`	`entityDefinition()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableQueryObject` that have equal attribute values.
`com.google.common.collect.ImmutableList<String>`	`fields()`
`String`	`filterExpression()`
`int`	`hashCode()` Computes a hash code from attributes: `sObject`, `selectedFieldNames`, `filterExpression`, `idFieldName`, `fields`, `dataType`, `entityDefinition`.
`String`	`idFieldName()`
`com.google.common.collect.ImmutableList<String>`	`selectedFieldNames()`
`String`	`sObject()`
`String`	`toString()` Prints the immutable value `QueryObject` with attribute values.
`ImmutableQueryObject`	`withDataType(String value)` Copy the current immutable object by setting a value for the `dataType` attribute.
`ImmutableQueryObject`	`withEntityDefinition(EntityDefinition value)` Copy the current immutable object by setting a value for the `entityDefinition` attribute.
`ImmutableQueryObject`	`withFields(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `fields`.
`ImmutableQueryObject`	`withFields(String... elements)` Copy the current immutable object with elements that replace the content of `fields`.
`ImmutableQueryObject`	`withFilterExpression(String value)` Copy the current immutable object by setting a value for the `filterExpression` attribute.
`ImmutableQueryObject`	`withIdFieldName(String value)` Copy the current immutable object by setting a value for the `idFieldName` attribute.
`ImmutableQueryObject`	`withSelectedFieldNames(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `selectedFieldNames`.
`ImmutableQueryObject`	`withSelectedFieldNames(String... elements)` Copy the current immutable object with elements that replace the content of `selectedFieldNames`.
`ImmutableQueryObject`	`withSObject(String value)` Copy the current immutable object by setting a value for the `sObject` attribute.

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

- Method Detail
  - sObject
```
public String sObject()
```
    Specified by:
    
    sObject in interface QueryObject
    
    Returns:
    
    The value of the sObject attribute
  - selectedFieldNames
```
@Nullable
public com.google.common.collect.ImmutableList<String> selectedFieldNames()
```
    Specified by:
    
    selectedFieldNames in interface QueryObject
    
    Returns:
    
    The value of the selectedFieldNames attribute
  - filterExpression
```
@Nullable
public String filterExpression()
```
    Specified by:
    
    filterExpression in interface QueryObject
    
    Returns:
    
    The value of the filterExpression attribute
  - idFieldName
```
@Nullable
public String idFieldName()
```
    Specified by:
    
    idFieldName in interface QueryObject
    
    Returns:
    
    The value of the idFieldName attribute
  - fields
```
@Nullable
public com.google.common.collect.ImmutableList<String> fields()
```
    Specified by:
    
    fields in interface QueryObject
    
    Returns:
    
    The value of the fields attribute
  - dataType
```
@Nullable
public String dataType()
```
    Specified by:
    
    dataType in interface QueryObject
    
    Returns:
    
    The value of the dataType attribute
  - entityDefinition
```
@Nullable
public EntityDefinition entityDefinition()
```
    Specified by:
    
    entityDefinition in interface QueryObject
    
    Returns:
    
    The value of the entityDefinition attribute
  - withSObject
```
public final ImmutableQueryObject withSObject(String value)
```
    Copy the current immutable object by setting a value for the sObject attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for sObject
    
    Returns:
    
    A modified copy of the this object
  - withSelectedFieldNames
```
public final ImmutableQueryObject 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 ImmutableQueryObject 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 ImmutableQueryObject 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
  - withIdFieldName
```
public final ImmutableQueryObject 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
  - withFields
```
public final ImmutableQueryObject withFields(@Nullable
                                             String... elements)
```
    Copy the current immutable object with elements that replace the content of fields.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withFields
```
public final ImmutableQueryObject withFields(@Nullable
                                             Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of fields. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of fields elements to set
    
    Returns:
    
    A modified copy of this object
  - withDataType
```
public final ImmutableQueryObject withDataType(@Nullable
                                               String value)
```
    Copy the current immutable object by setting a value for the dataType attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for dataType (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withEntityDefinition
```
public final ImmutableQueryObject withEntityDefinition(@Nullable
                                                       EntityDefinition value)
```
    Copy the current immutable object by setting a value for the entityDefinition attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for entityDefinition (can be null)
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableQueryObject 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: sObject, selectedFieldNames, filterExpression, idFieldName, fields, dataType, entityDefinition.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value QueryObject with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableQueryObject copyOf(QueryObject instance)
```
    Creates an immutable copy of a QueryObject 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 QueryObject instance
  - builder
```
public static ImmutableQueryObject.Builder builder()
```
    Creates a builder for ImmutableQueryObject.
```
 ImmutableQueryObject.builder()
    .sObject(String) // required sObject
    .selectedFieldNames(List&lt;String&gt; | null) // nullable selectedFieldNames
    .filterExpression(String | null) // nullable filterExpression
    .idFieldName(String | null) // nullable idFieldName
    .fields(List&lt;String&gt; | null) // nullable fields
    .dataType(String | null) // nullable dataType
    .entityDefinition(com.amazonaws.appflow.custom.connector.model.metadata.EntityDefinition | null) // nullable entityDefinition
    .build();
 
```
    Returns:
    
    A new ImmutableQueryObject builder

Class ImmutableQueryObject

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

sObject

selectedFieldNames

filterExpression

idFieldName

fields

dataType

entityDefinition

withSObject

withSelectedFieldNames

withSelectedFieldNames

withFilterExpression

withIdFieldName

withFields

withFields

withDataType

withEntityDefinition

equals

hashCode

toString

copyOf

builder