StartContactEvaluationRequest (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.StartContactEvaluationRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartContactEvaluationRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

Evaluations created through the public API do not contain answer values suggested from automation.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartContactEvaluationRequest()

Constructors
Constructor and Description
`StartContactEvaluationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`java.lang.String`	`getContactId()` The identifier of the contact in this instance of Amazon Connect.
`java.lang.String`	`getEvaluationFormId()` The unique identifier for the evaluation form.
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`int`	`hashCode()`
`void`	`setClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setContactId(java.lang.String contactId)` The identifier of the contact in this instance of Amazon Connect.
`void`	`setEvaluationFormId(java.lang.String evaluationFormId)` The unique identifier for the evaluation form.
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartContactEvaluationRequest`	`withClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`StartContactEvaluationRequest`	`withContactId(java.lang.String contactId)` The identifier of the contact in this instance of Amazon Connect.
`StartContactEvaluationRequest`	`withEvaluationFormId(java.lang.String evaluationFormId)` The unique identifier for the evaluation form.
`StartContactEvaluationRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - StartContactEvaluationRequest
```
public StartContactEvaluationRequest()
```
- Method Detail
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - withInstanceId
```
public StartContactEvaluationRequest withInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getContactId
```
public java.lang.String getContactId()
```
    The identifier of the contact in this instance of Amazon Connect.
    
    Constraints:
    Length: 1 - 256
    
    Returns:
    
    The identifier of the contact in this instance of Amazon Connect.
  - setContactId
```
public void setContactId(java.lang.String contactId)
```
    The identifier of the contact in this instance of Amazon Connect.
    
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    contactId -
    The identifier of the contact in this instance of Amazon Connect.
  - withContactId
```
public StartContactEvaluationRequest withContactId(java.lang.String contactId)
```
    The identifier of the contact in this instance of Amazon Connect.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    
    contactId -
    The identifier of the contact in this instance of Amazon Connect.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEvaluationFormId
```
public java.lang.String getEvaluationFormId()
```
    The unique identifier for the evaluation form.
    
    Constraints:
    Length: 1 - 500
    
    Returns:
    
    The unique identifier for the evaluation form.
  - setEvaluationFormId
```
public void setEvaluationFormId(java.lang.String evaluationFormId)
```
    The unique identifier for the evaluation form.
    
    Constraints:
    Length: 1 - 500
    
    Parameters:
    
    evaluationFormId -
    The unique identifier for the evaluation form.
  - withEvaluationFormId
```
public StartContactEvaluationRequest withEvaluationFormId(java.lang.String evaluationFormId)
```
    The unique identifier for the evaluation form.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 500
    
    Parameters:
    
    evaluationFormId -
    The unique identifier for the evaluation form.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientToken
```
public java.lang.String getClientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Constraints:
    Length: - 500
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
  - setClientToken
```
public void setClientToken(java.lang.String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
  - withClientToken
```
public StartContactEvaluationRequest withClientToken(java.lang.String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StartContactEvaluationRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartContactEvaluationRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getContactId

setContactId

withContactId

getEvaluationFormId

setEvaluationFormId

withEvaluationFormId

getClientToken

setClientToken

withClientToken

toString

hashCode

equals