WatchlistScreeningEntityListRequest (com.plaid:plaid-java 29.0.0 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class WatchlistScreeningEntityListRequest
extends Object

Request input for listing entity watchlist screenings

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ASSIGNEE`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_CLIENT_USER_ID`
`static String`	`SERIALIZED_NAME_CURSOR`
`static String`	`SERIALIZED_NAME_ENTITY_WATCHLIST_PROGRAM_ID`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_STATUS`

Constructor Summary

Constructors
Constructor and Description

WatchlistScreeningEntityListRequest()

Constructors
Constructor and Description
`WatchlistScreeningEntityListRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WatchlistScreeningEntityListRequest`	`assignee(String assignee)`
`WatchlistScreeningEntityListRequest`	`clientId(String clientId)`
`WatchlistScreeningEntityListRequest`	`clientUserId(String clientUserId)`
`WatchlistScreeningEntityListRequest`	`cursor(String cursor)`
`WatchlistScreeningEntityListRequest`	`entityWatchlistProgramId(String entityWatchlistProgramId)`
`boolean`	`equals(Object o)`
`String`	`getAssignee()` ID of the associated user.
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getClientUserId()` A unique ID that identifies the end user in your system.
`String`	`getCursor()` An identifier that determines which page of results you receive.
`String`	`getEntityWatchlistProgramId()` ID of the associated entity program.
`String`	`getSecret()` Your Plaid API `secret`.
`WatchlistScreeningStatus`	`getStatus()` Get status
`int`	`hashCode()`
`WatchlistScreeningEntityListRequest`	`secret(String secret)`
`void`	`setAssignee(String assignee)`
`void`	`setClientId(String clientId)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setCursor(String cursor)`
`void`	`setEntityWatchlistProgramId(String entityWatchlistProgramId)`
`void`	`setSecret(String secret)`
`void`	`setStatus(WatchlistScreeningStatus status)`
`WatchlistScreeningEntityListRequest`	`status(WatchlistScreeningStatus status)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_SECRET
```
public static final String SERIALIZED_NAME_SECRET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_ID
```
public static final String SERIALIZED_NAME_CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ENTITY_WATCHLIST_PROGRAM_ID
```
public static final String SERIALIZED_NAME_ENTITY_WATCHLIST_PROGRAM_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_USER_ID
```
public static final String SERIALIZED_NAME_CLIENT_USER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATUS
```
public static final String SERIALIZED_NAME_STATUS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ASSIGNEE
```
public static final String SERIALIZED_NAME_ASSIGNEE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CURSOR
```
public static final String SERIALIZED_NAME_CURSOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WatchlistScreeningEntityListRequest
```
public WatchlistScreeningEntityListRequest()
```
- Method Detail
  - secret
```
public WatchlistScreeningEntityListRequest secret(String secret)
```
  - getSecret
```
@Nullable
public String getSecret()
```
    Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
    
    Returns:
    
    secret
  - setSecret
```
public void setSecret(String secret)
```
  - clientId
```
public WatchlistScreeningEntityListRequest clientId(String clientId)
```
  - getClientId
```
@Nullable
public String getClientId()
```
    Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
    
    Returns:
    
    clientId
  - setClientId
```
public void setClientId(String clientId)
```
  - entityWatchlistProgramId
```
public WatchlistScreeningEntityListRequest entityWatchlistProgramId(String entityWatchlistProgramId)
```
  - getEntityWatchlistProgramId
```
public String getEntityWatchlistProgramId()
```
    ID of the associated entity program.
    
    Returns:
    
    entityWatchlistProgramId
  - setEntityWatchlistProgramId
```
public void setEntityWatchlistProgramId(String entityWatchlistProgramId)
```
  - clientUserId
```
public WatchlistScreeningEntityListRequest clientUserId(String clientUserId)
```
  - getClientUserId
```
@Nullable
public String getClientUserId()
```
    A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the `/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - status
```
public WatchlistScreeningEntityListRequest status(WatchlistScreeningStatus status)
```
  - getStatus
```
@Nullable
public WatchlistScreeningStatus getStatus()
```
    Get status
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(WatchlistScreeningStatus status)
```
  - assignee
```
public WatchlistScreeningEntityListRequest assignee(String assignee)
```
  - getAssignee
```
@Nullable
public String getAssignee()
```
    ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use `/dashboard_user/get`.
    
    Returns:
    
    assignee
  - setAssignee
```
public void setAssignee(String assignee)
```
  - cursor
```
public WatchlistScreeningEntityListRequest cursor(String cursor)
```
  - getCursor
```
@Nullable
public String getCursor()
```
    An identifier that determines which page of results you receive.
    
    Returns:
    
    cursor
  - setCursor
```
public void setCursor(String cursor)
```
  - 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 WatchlistScreeningEntityListRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_ENTITY_WATCHLIST_PROGRAM_ID

SERIALIZED_NAME_CLIENT_USER_ID

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_ASSIGNEE

SERIALIZED_NAME_CURSOR

Constructor Detail

WatchlistScreeningEntityListRequest

Method Detail

secret

getSecret

setSecret

clientId

getClientId

setClientId

entityWatchlistProgramId

getEntityWatchlistProgramId

setEntityWatchlistProgramId

clientUserId

getClientUserId

setClientUserId

status

getStatus

setStatus

assignee

getAssignee

setAssignee

cursor

getCursor

setCursor

equals

hashCode

toString