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

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class LinkEventMetadata
extends Object

Metadata about an event that occured while the user was going through Link

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT_NUMBER_MASK`
`static String`	`SERIALIZED_NAME_BRAND_NAME`
`static String`	`SERIALIZED_NAME_ERROR_CODE`
`static String`	`SERIALIZED_NAME_ERROR_MESSAGE`
`static String`	`SERIALIZED_NAME_ERROR_TYPE`
`static String`	`SERIALIZED_NAME_EXIT_STATUS`
`static String`	`SERIALIZED_NAME_INSTITUTION_ID`
`static String`	`SERIALIZED_NAME_INSTITUTION_NAME`
`static String`	`SERIALIZED_NAME_INSTITUTION_SEARCH_QUERY`
`static String`	`SERIALIZED_NAME_MATCH_REASON`
`static String`	`SERIALIZED_NAME_MFA_TYPE`
`static String`	`SERIALIZED_NAME_REQUEST_ID`
`static String`	`SERIALIZED_NAME_ROUTING_NUMBER`
`static String`	`SERIALIZED_NAME_SELECTION`
`static String`	`SERIALIZED_NAME_VIEW_NAME`

Constructor Summary

Constructors
Constructor and Description

LinkEventMetadata()

Constructors
Constructor and Description
`LinkEventMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LinkEventMetadata`	`accountNumberMask(String accountNumberMask)`
`LinkEventMetadata`	`brandName(String brandName)`
`boolean`	`equals(Object o)`
`LinkEventMetadata`	`errorCode(String errorCode)`
`LinkEventMetadata`	`errorMessage(String errorMessage)`
`LinkEventMetadata`	`errorType(String errorType)`
`LinkEventMetadata`	`exitStatus(String exitStatus)`
`String`	`getAccountNumberMask()` The account number mask extracted from the user-provided account number.
`String`	`getBrandName()` The name of the selected brand.
`String`	`getErrorCode()` The error code that the user encountered.
`String`	`getErrorMessage()` The error message that the user encountered.
`String`	`getErrorType()` The error type that the user encountered.
`String`	`getExitStatus()` The status key indicates the point at which the user exited the Link flow.
`String`	`getInstitutionId()` The ID of the selected institution.
`String`	`getInstitutionName()` The name of the selected institution.
`String`	`getInstitutionSearchQuery()` The query used to search for institutions.
`String`	`getMatchReason()` The reason this institution was matched, which will be either `returning_user` or `routing_number`.
`String`	`getMfaType()` If set, the user has encountered one of the following MFA types: code, device, questions, selections.
`String`	`getRequestId()` The request ID for the last request made by Link.
`String`	`getRoutingNumber()` The routing number submitted by user at the micro-deposits routing number pane.
`String`	`getSelection()` Either the verification method for a matched institution selected by the user or the Auth Type Select flow type selected by the user.
`String`	`getViewName()` The name of the view that is being transitioned to.
`int`	`hashCode()`
`LinkEventMetadata`	`institutionId(String institutionId)`
`LinkEventMetadata`	`institutionName(String institutionName)`
`LinkEventMetadata`	`institutionSearchQuery(String institutionSearchQuery)`
`LinkEventMetadata`	`matchReason(String matchReason)`
`LinkEventMetadata`	`mfaType(String mfaType)`
`LinkEventMetadata`	`requestId(String requestId)`
`LinkEventMetadata`	`routingNumber(String routingNumber)`
`LinkEventMetadata`	`selection(String selection)`
`void`	`setAccountNumberMask(String accountNumberMask)`
`void`	`setBrandName(String brandName)`
`void`	`setErrorCode(String errorCode)`
`void`	`setErrorMessage(String errorMessage)`
`void`	`setErrorType(String errorType)`
`void`	`setExitStatus(String exitStatus)`
`void`	`setInstitutionId(String institutionId)`
`void`	`setInstitutionName(String institutionName)`
`void`	`setInstitutionSearchQuery(String institutionSearchQuery)`
`void`	`setMatchReason(String matchReason)`
`void`	`setMfaType(String mfaType)`
`void`	`setRequestId(String requestId)`
`void`	`setRoutingNumber(String routingNumber)`
`void`	`setSelection(String selection)`
`void`	`setViewName(String viewName)`
`String`	`toString()`
`LinkEventMetadata`	`viewName(String viewName)`

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

- Field Detail
  - SERIALIZED_NAME_ERROR_CODE
```
public static final String SERIALIZED_NAME_ERROR_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ERROR_MESSAGE
```
public static final String SERIALIZED_NAME_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ERROR_TYPE
```
public static final String SERIALIZED_NAME_ERROR_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXIT_STATUS
```
public static final String SERIALIZED_NAME_EXIT_STATUS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_ID
```
public static final String SERIALIZED_NAME_INSTITUTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_NAME
```
public static final String SERIALIZED_NAME_INSTITUTION_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_SEARCH_QUERY
```
public static final String SERIALIZED_NAME_INSTITUTION_SEARCH_QUERY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REQUEST_ID
```
public static final String SERIALIZED_NAME_REQUEST_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MFA_TYPE
```
public static final String SERIALIZED_NAME_MFA_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VIEW_NAME
```
public static final String SERIALIZED_NAME_VIEW_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SELECTION
```
public static final String SERIALIZED_NAME_SELECTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BRAND_NAME
```
public static final String SERIALIZED_NAME_BRAND_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MATCH_REASON
```
public static final String SERIALIZED_NAME_MATCH_REASON
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ROUTING_NUMBER
```
public static final String SERIALIZED_NAME_ROUTING_NUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_NUMBER_MASK
```
public static final String SERIALIZED_NAME_ACCOUNT_NUMBER_MASK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LinkEventMetadata
```
public LinkEventMetadata()
```
- Method Detail
  - errorCode
```
public LinkEventMetadata errorCode(String errorCode)
```
  - getErrorCode
```
@Nullable
public String getErrorCode()
```
    The error code that the user encountered. Emitted by `ERROR`, `EXIT`.
    
    Returns:
    
    errorCode
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
  - errorMessage
```
public LinkEventMetadata errorMessage(String errorMessage)
```
  - getErrorMessage
```
@Nullable
public String getErrorMessage()
```
    The error message that the user encountered. Emitted by: `ERROR`, `EXIT`.
    
    Returns:
    
    errorMessage
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
  - errorType
```
public LinkEventMetadata errorType(String errorType)
```
  - getErrorType
```
@Nullable
public String getErrorType()
```
    The error type that the user encountered. Emitted by: `ERROR`, `EXIT`.
    
    Returns:
    
    errorType
  - setErrorType
```
public void setErrorType(String errorType)
```
  - exitStatus
```
public LinkEventMetadata exitStatus(String exitStatus)
```
  - getExitStatus
```
@Nullable
public String getExitStatus()
```
    The status key indicates the point at which the user exited the Link flow. Emitted by: `EXIT`.
    
    Returns:
    
    exitStatus
  - setExitStatus
```
public void setExitStatus(String exitStatus)
```
  - institutionId
```
public LinkEventMetadata institutionId(String institutionId)
```
  - getInstitutionId
```
@Nullable
public String getInstitutionId()
```
    The ID of the selected institution. Emitted by: all events.
    
    Returns:
    
    institutionId
  - setInstitutionId
```
public void setInstitutionId(String institutionId)
```
  - institutionName
```
public LinkEventMetadata institutionName(String institutionName)
```
  - getInstitutionName
```
@Nullable
public String getInstitutionName()
```
    The name of the selected institution. Emitted by: all events.
    
    Returns:
    
    institutionName
  - setInstitutionName
```
public void setInstitutionName(String institutionName)
```
  - institutionSearchQuery
```
public LinkEventMetadata institutionSearchQuery(String institutionSearchQuery)
```
  - getInstitutionSearchQuery
```
@Nullable
public String getInstitutionSearchQuery()
```
    The query used to search for institutions. Emitted by: `SEARCH_INSTITUTION`.
    
    Returns:
    
    institutionSearchQuery
  - setInstitutionSearchQuery
```
public void setInstitutionSearchQuery(String institutionSearchQuery)
```
  - requestId
```
public LinkEventMetadata requestId(String requestId)
```
  - getRequestId
```
public String getRequestId()
```
    The request ID for the last request made by Link. This can be shared with Plaid Support to expedite investigation. Emitted by: all events.
    
    Returns:
    
    requestId
  - setRequestId
```
public void setRequestId(String requestId)
```
  - mfaType
```
public LinkEventMetadata mfaType(String mfaType)
```
  - getMfaType
```
@Nullable
public String getMfaType()
```
    If set, the user has encountered one of the following MFA types: code, device, questions, selections. Emitted by: `SUBMIT_MFA` and `TRANSITION_VIEW` when view_name is `MFA`.
    
    Returns:
    
    mfaType
  - setMfaType
```
public void setMfaType(String mfaType)
```
  - viewName
```
public LinkEventMetadata viewName(String viewName)
```
  - getViewName
```
@Nullable
public String getViewName()
```
    The name of the view that is being transitioned to. Emitted by: `TRANSITION_VIEW`.
    
    Returns:
    
    viewName
  - setViewName
```
public void setViewName(String viewName)
```
  - selection
```
public LinkEventMetadata selection(String selection)
```
  - getSelection
```
@Nullable
public String getSelection()
```
    Either the verification method for a matched institution selected by the user or the Auth Type Select flow type selected by the user. If selection is used to describe selected verification method, then possible values are `phoneotp` or `password`; if selection is used to describe the selected Auth Type Select flow, then possible values are `flow_type_manual` or `flow_type_instant`. Emitted by: `MATCHED_SELECT_VERIFY_METHOD` and `SELECT_AUTH_TYPE`.
    
    Returns:
    
    selection
  - setSelection
```
public void setSelection(String selection)
```
  - brandName
```
public LinkEventMetadata brandName(String brandName)
```
  - getBrandName
```
@Nullable
public String getBrandName()
```
    The name of the selected brand.
    
    Returns:
    
    brandName
  - setBrandName
```
public void setBrandName(String brandName)
```
  - matchReason
```
public LinkEventMetadata matchReason(String matchReason)
```
  - getMatchReason
```
@Nullable
public String getMatchReason()
```
    The reason this institution was matched, which will be either `returning_user` or `routing_number`. Emitted by: `MATCHED_SELECT_INSTITUTION`.
    
    Returns:
    
    matchReason
  - setMatchReason
```
public void setMatchReason(String matchReason)
```
  - routingNumber
```
public LinkEventMetadata routingNumber(String routingNumber)
```
  - getRoutingNumber
```
@Nullable
public String getRoutingNumber()
```
    The routing number submitted by user at the micro-deposits routing number pane. Emitted by `SUBMIT_ROUTING_NUMBER`.
    
    Returns:
    
    routingNumber
  - setRoutingNumber
```
public void setRoutingNumber(String routingNumber)
```
  - accountNumberMask
```
public LinkEventMetadata accountNumberMask(String accountNumberMask)
```
  - getAccountNumberMask
```
@Nullable
public String getAccountNumberMask()
```
    The account number mask extracted from the user-provided account number. If the user-inputted account number is four digits long, `account_number_mask` is empty. Emitted by `SUBMIT_ACCOUNT_NUMBER`.
    
    Returns:
    
    accountNumberMask
  - setAccountNumberMask
```
public void setAccountNumberMask(String accountNumberMask)
```
  - 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 LinkEventMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ERROR_CODE

SERIALIZED_NAME_ERROR_MESSAGE

SERIALIZED_NAME_ERROR_TYPE

SERIALIZED_NAME_EXIT_STATUS

SERIALIZED_NAME_INSTITUTION_ID

SERIALIZED_NAME_INSTITUTION_NAME

SERIALIZED_NAME_INSTITUTION_SEARCH_QUERY

SERIALIZED_NAME_REQUEST_ID

SERIALIZED_NAME_MFA_TYPE

SERIALIZED_NAME_VIEW_NAME

SERIALIZED_NAME_SELECTION

SERIALIZED_NAME_BRAND_NAME

SERIALIZED_NAME_MATCH_REASON

SERIALIZED_NAME_ROUTING_NUMBER

SERIALIZED_NAME_ACCOUNT_NUMBER_MASK

Constructor Detail

LinkEventMetadata

Method Detail

errorCode

getErrorCode

setErrorCode

errorMessage

getErrorMessage

setErrorMessage

errorType

getErrorType

setErrorType

exitStatus

getExitStatus

setExitStatus

institutionId

getInstitutionId

setInstitutionId

institutionName

getInstitutionName

setInstitutionName

institutionSearchQuery

getInstitutionSearchQuery

setInstitutionSearchQuery

requestId

getRequestId

setRequestId

mfaType

getMfaType

setMfaType

viewName

getViewName

setViewName

selection

getSelection

setSelection

brandName

getBrandName

setBrandName

matchReason

getMatchReason

setMatchReason

routingNumber

getRoutingNumber

setRoutingNumber

accountNumberMask

getAccountNumberMask

setAccountNumberMask

equals

hashCode

toString