AssetReportCreateRequestOptions (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.AssetReportCreateRequestOptions

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class AssetReportCreateRequestOptions
extends Object
```
An optional object to filter `/asset_report/create` results. If provided, must be non-`null`. The optional `user` object is required for the report to be eligible for Fannie Mae's Day 1 Certainty program.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ADD_ONS`
`static String`	`SERIALIZED_NAME_CLIENT_REPORT_ID`
`static String`	`SERIALIZED_NAME_INCLUDE_FAST_REPORT`
`static String`	`SERIALIZED_NAME_PRODUCTS`
`static String`	`SERIALIZED_NAME_USER`
`static String`	`SERIALIZED_NAME_WEBHOOK`

Constructor Summary

Constructors
Constructor and Description

AssetReportCreateRequestOptions()

Constructors
Constructor and Description
`AssetReportCreateRequestOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssetReportCreateRequestOptions`	`addAddOnsItem(AssetReportAddOns addOnsItem)`
`AssetReportCreateRequestOptions`	`addOns(List<AssetReportAddOns> addOns)`
`AssetReportCreateRequestOptions`	`addProductsItem(String productsItem)`
`AssetReportCreateRequestOptions`	`clientReportId(String clientReportId)`
`boolean`	`equals(Object o)`
`List<AssetReportAddOns>`	`getAddOns()` Use this field to request a `fast_asset` report.
`String`	`getClientReportId()` Client-generated identifier, which can be used by lenders to track loan applications.
`Boolean`	`getIncludeFastReport()` true to return balance and identity earlier as a fast report.
`List<String>`	`getProducts()` Additional information that can be included in the asset report.
`AssetReportUser`	`getUser()` Get user
`String`	`getWebhook()` URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.
`int`	`hashCode()`
`AssetReportCreateRequestOptions`	`includeFastReport(Boolean includeFastReport)`
`AssetReportCreateRequestOptions`	`products(List<String> products)`
`void`	`setAddOns(List<AssetReportAddOns> addOns)`
`void`	`setClientReportId(String clientReportId)`
`void`	`setIncludeFastReport(Boolean includeFastReport)`
`void`	`setProducts(List<String> products)`
`void`	`setUser(AssetReportUser user)`
`void`	`setWebhook(String webhook)`
`String`	`toString()`
`AssetReportCreateRequestOptions`	`user(AssetReportUser user)`
`AssetReportCreateRequestOptions`	`webhook(String webhook)`

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

- Field Detail
  - SERIALIZED_NAME_CLIENT_REPORT_ID
```
public static final String SERIALIZED_NAME_CLIENT_REPORT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WEBHOOK
```
public static final String SERIALIZED_NAME_WEBHOOK
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INCLUDE_FAST_REPORT
```
public static final String SERIALIZED_NAME_INCLUDE_FAST_REPORT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PRODUCTS
```
public static final String SERIALIZED_NAME_PRODUCTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ADD_ONS
```
public static final String SERIALIZED_NAME_ADD_ONS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER
```
public static final String SERIALIZED_NAME_USER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AssetReportCreateRequestOptions
```
public AssetReportCreateRequestOptions()
```
- Method Detail
  - clientReportId
```
public AssetReportCreateRequestOptions clientReportId(String clientReportId)
```
  - getClientReportId
```
@Nullable
public String getClientReportId()
```
    Client-generated identifier, which can be used by lenders to track loan applications.
    
    Returns:
    
    clientReportId
  - setClientReportId
```
public void setClientReportId(String clientReportId)
```
  - webhook
```
public AssetReportCreateRequestOptions webhook(String webhook)
```
  - getWebhook
```
@Nullable
public String getWebhook()
```
    URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.
    
    Returns:
    
    webhook
  - setWebhook
```
public void setWebhook(String webhook)
```
  - includeFastReport
```
public AssetReportCreateRequestOptions includeFastReport(Boolean includeFastReport)
```
  - getIncludeFastReport
```
@Nullable
public Boolean getIncludeFastReport()
```
    true to return balance and identity earlier as a fast report. Defaults to false if omitted.
    
    Returns:
    
    includeFastReport
  - setIncludeFastReport
```
public void setIncludeFastReport(Boolean includeFastReport)
```
  - products
```
public AssetReportCreateRequestOptions products(List<String> products)
```
  - addProductsItem
```
public AssetReportCreateRequestOptions addProductsItem(String productsItem)
```
  - getProducts
```
@Nullable
public List<String> getProducts()
```
    Additional information that can be included in the asset report. Possible values: `\"investments\"`
    
    Returns:
    
    products
  - setProducts
```
public void setProducts(List<String> products)
```
  - addOns
```
public AssetReportCreateRequestOptions addOns(List<AssetReportAddOns> addOns)
```
  - addAddOnsItem
```
public AssetReportCreateRequestOptions addAddOnsItem(AssetReportAddOns addOnsItem)
```
  - getAddOns
```
@Nullable
public List<AssetReportAddOns> getAddOns()
```
    Use this field to request a `fast_asset` report. When Fast Assets is requested, Plaid will create two versions of the Asset Report: first, the Fast Asset Report, which will contain only current identity and balance information, and later, the Full Asset Report, which will also contain historical balance information and transaction data. A `PRODUCT_READY` webhook will be fired for each Asset Report when it is ready, and the `report_type` field will indicate whether the webhook is firing for the `full` or `fast` Asset Report. To retrieve the Fast Asset Report, call `/asset_report/get` with `fast_report` set to `true`. There is no additional charge for using Fast Assets.
    
    Returns:
    
    addOns
  - setAddOns
```
public void setAddOns(List<AssetReportAddOns> addOns)
```
  - user
```
public AssetReportCreateRequestOptions user(AssetReportUser user)
```
  - getUser
```
@Nullable
public AssetReportUser getUser()
```
    Get user
    
    Returns:
    
    user
  - setUser
```
public void setUser(AssetReportUser user)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AssetReportCreateRequestOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_REPORT_ID

SERIALIZED_NAME_WEBHOOK

SERIALIZED_NAME_INCLUDE_FAST_REPORT

SERIALIZED_NAME_PRODUCTS

SERIALIZED_NAME_ADD_ONS

SERIALIZED_NAME_USER

Constructor Detail

AssetReportCreateRequestOptions

Method Detail

clientReportId

getClientReportId

setClientReportId

webhook

getWebhook

setWebhook

includeFastReport

getIncludeFastReport

setIncludeFastReport

products

addProductsItem

getProducts

setProducts

addOns

addAddOnsItem

getAddOns

setAddOns

user

getUser

setUser

equals

hashCode

toString