com.amazonaws.services.connectparticipant.model

Class GetTranscriptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connectparticipant.model.GetTranscriptRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetTranscriptRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetTranscriptRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getConnectionToken() The authentication token associated with the participant's connection.
java.lang.String	getContactId() The contactId from the current contact chain for which transcript is needed.
java.lang.Integer	getMaxResults() The maximum number of results to return in the page.
java.lang.String	getNextToken() The pagination token.
java.lang.String	getScanDirection() The direction from StartPosition from which to retrieve message.
java.lang.String	getSortOrder() The sort order for the records.
StartPosition	getStartPosition() A filtering option for where to start.
int	hashCode()
void	setConnectionToken(java.lang.String connectionToken) The authentication token associated with the participant's connection.
void	setContactId(java.lang.String contactId) The contactId from the current contact chain for which transcript is needed.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of results to return in the page.
void	setNextToken(java.lang.String nextToken) The pagination token.
void	setScanDirection(ScanDirection scanDirection) The direction from StartPosition from which to retrieve message.
void	setScanDirection(java.lang.String scanDirection) The direction from StartPosition from which to retrieve message.
void	setSortOrder(SortKey sortOrder) The sort order for the records.
void	setSortOrder(java.lang.String sortOrder) The sort order for the records.
void	setStartPosition(StartPosition startPosition) A filtering option for where to start.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetTranscriptRequest	withConnectionToken(java.lang.String connectionToken) The authentication token associated with the participant's connection.
GetTranscriptRequest	withContactId(java.lang.String contactId) The contactId from the current contact chain for which transcript is needed.
GetTranscriptRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of results to return in the page.
GetTranscriptRequest	withNextToken(java.lang.String nextToken) The pagination token.
GetTranscriptRequest	withScanDirection(ScanDirection scanDirection) The direction from StartPosition from which to retrieve message.
GetTranscriptRequest	withScanDirection(java.lang.String scanDirection) The direction from StartPosition from which to retrieve message.
GetTranscriptRequest	withSortOrder(SortKey sortOrder) The sort order for the records.
GetTranscriptRequest	withSortOrder(java.lang.String sortOrder) The sort order for the records.
GetTranscriptRequest	withStartPosition(StartPosition startPosition) A filtering option for where to start.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetTranscriptRequest

public GetTranscriptRequest()

Method Detail

getContactId

public java.lang.String getContactId()

The contactId from the current contact chain for which transcript is needed.

Constraints:
Length: 1 - 256

Returns:

The contactId from the current contact chain for which transcript is needed.

setContactId

public void setContactId(java.lang.String contactId)

The contactId from the current contact chain for which transcript is needed.

Constraints:
Length: 1 - 256

Parameters:

contactId -

The contactId from the current contact chain for which transcript is needed.

withContactId

public GetTranscriptRequest withContactId(java.lang.String contactId)

The contactId from the current contact chain for which transcript is needed.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

contactId -

The contactId from the current contact chain for which transcript is needed.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of results to return in the page. Default: 10.

Constraints:
Range: 0 - 100

Returns:

The maximum number of results to return in the page. Default: 10.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of results to return in the page. Default: 10.

Constraints:
Range: 0 - 100

Parameters:

maxResults -

The maximum number of results to return in the page. Default: 10.

withMaxResults

public GetTranscriptRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of results to return in the page. Default: 10.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 - 100

Parameters:

maxResults -

The maximum number of results to return in the page. Default: 10.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Constraints:
Length: 1 - 1000

Returns:

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

setNextToken

public void setNextToken(java.lang.String nextToken)

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Constraints:
Length: 1 - 1000

Parameters:

nextToken -

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

withNextToken

public GetTranscriptRequest withNextToken(java.lang.String nextToken)

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1000

Parameters:

nextToken -

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Returns:

A reference to this updated object so that method calls can be chained together.

getScanDirection

public java.lang.String getScanDirection()

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Constraints:
Allowed Values: FORWARD, BACKWARD

Returns:

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

See Also:

ScanDirection

setScanDirection

public void setScanDirection(java.lang.String scanDirection)

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Constraints:
Allowed Values: FORWARD, BACKWARD

Parameters:

scanDirection -

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

See Also:

ScanDirection

withScanDirection

public GetTranscriptRequest withScanDirection(java.lang.String scanDirection)

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: FORWARD, BACKWARD

Parameters:

scanDirection -

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ScanDirection

setScanDirection

public void setScanDirection(ScanDirection scanDirection)

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Constraints:
Allowed Values: FORWARD, BACKWARD

Parameters:

scanDirection -

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

See Also:

ScanDirection

withScanDirection

public GetTranscriptRequest withScanDirection(ScanDirection scanDirection)

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: FORWARD, BACKWARD

Parameters:

scanDirection -

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ScanDirection

getSortOrder

public java.lang.String getSortOrder()

The sort order for the records. Default: DESCENDING.

Constraints:
Allowed Values: DESCENDING, ASCENDING

Returns:

The sort order for the records. Default: DESCENDING.

See Also:

SortKey

setSortOrder

public void setSortOrder(java.lang.String sortOrder)

The sort order for the records. Default: DESCENDING.

Constraints:
Allowed Values: DESCENDING, ASCENDING

Parameters:

sortOrder -

The sort order for the records. Default: DESCENDING.

See Also:

SortKey

withSortOrder

public GetTranscriptRequest withSortOrder(java.lang.String sortOrder)

The sort order for the records. Default: DESCENDING.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: DESCENDING, ASCENDING

Parameters:

sortOrder -

The sort order for the records. Default: DESCENDING.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SortKey

setSortOrder

public void setSortOrder(SortKey sortOrder)

The sort order for the records. Default: DESCENDING.

Constraints:
Allowed Values: DESCENDING, ASCENDING

Parameters:

sortOrder -

The sort order for the records. Default: DESCENDING.

See Also:

SortKey

withSortOrder

public GetTranscriptRequest withSortOrder(SortKey sortOrder)

The sort order for the records. Default: DESCENDING.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: DESCENDING, ASCENDING

Parameters:

sortOrder -

The sort order for the records. Default: DESCENDING.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SortKey

getStartPosition

public StartPosition getStartPosition()

A filtering option for where to start.

Returns:

A filtering option for where to start.

setStartPosition

public void setStartPosition(StartPosition startPosition)

A filtering option for where to start.

Parameters:

startPosition -

A filtering option for where to start.

withStartPosition

public GetTranscriptRequest withStartPosition(StartPosition startPosition)

A filtering option for where to start.

Returns a reference to this object so that method calls can be chained together.

Parameters:

startPosition -

A filtering option for where to start.

Returns:

A reference to this updated object so that method calls can be chained together.

getConnectionToken

public java.lang.String getConnectionToken()

The authentication token associated with the participant's connection.

Constraints:
Length: 1 - 1000

Returns:

The authentication token associated with the participant's connection.

setConnectionToken

public void setConnectionToken(java.lang.String connectionToken)

The authentication token associated with the participant's connection.

Constraints:
Length: 1 - 1000

Parameters:

connectionToken -

The authentication token associated with the participant's connection.

withConnectionToken

public GetTranscriptRequest withConnectionToken(java.lang.String connectionToken)

The authentication token associated with the participant's connection.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1000

Parameters:

connectionToken -

The authentication token associated with the participant's connection.

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