com.amazonaws.services.connectparticipant.model

Class GetTranscriptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connectparticipant.model.GetTranscriptRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetTranscriptRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetTranscriptRequest()

Method Summary

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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetTranscriptRequest

public GetTranscriptRequest()

Method Detail

setContactId

public void setContactId(String contactId)

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

Parameters:

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

getContactId

public String getContactId()

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

Returns:

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

withContactId

public GetTranscriptRequest withContactId(String contactId)

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

Parameters:

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

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

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

Parameters:

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

getMaxResults

public Integer getMaxResults()

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

Returns:

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

withMaxResults

public GetTranscriptRequest withMaxResults(Integer maxResults)

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

Parameters:

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

Returns:

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

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public GetTranscriptRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

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

setScanDirection

public void setScanDirection(String scanDirection)

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

Parameters:

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

See Also:

ScanDirection

getScanDirection

public String getScanDirection()

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

Returns:

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(String scanDirection)

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

Parameters:

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

Returns:

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

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.

Parameters:

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

Returns:

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

See Also:

ScanDirection

setSortOrder

public void setSortOrder(String sortOrder)

The sort order for the records. Default: DESCENDING.

Parameters:

sortOrder - The sort order for the records. Default: DESCENDING.

See Also:

SortKey

getSortOrder

public String getSortOrder()

The sort order for the records. Default: DESCENDING.

Returns:

The sort order for the records. Default: DESCENDING.

See Also:

SortKey

withSortOrder

public GetTranscriptRequest withSortOrder(String sortOrder)

The sort order for the records. Default: DESCENDING.

Parameters:

sortOrder - The sort order for the records. Default: DESCENDING.

Returns:

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

See Also:

SortKey

withSortOrder

public GetTranscriptRequest withSortOrder(SortKey sortOrder)

The sort order for the records. Default: DESCENDING.

Parameters:

sortOrder - The sort order for the records. Default: DESCENDING.

Returns:

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

See Also:

SortKey

setStartPosition

public void setStartPosition(StartPosition startPosition)

A filtering option for where to start.

Parameters:

startPosition - A filtering option for where to start.

getStartPosition

public StartPosition getStartPosition()

A filtering option for where to start.

Returns:

A filtering option for where to start.

withStartPosition

public GetTranscriptRequest withStartPosition(StartPosition startPosition)

A filtering option for where to start.

Parameters:

startPosition - A filtering option for where to start.

Returns:

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

setConnectionToken

public void setConnectionToken(String connectionToken)

The authentication token associated with the participant's connection.

Parameters:

connectionToken - The authentication token associated with the participant's connection.

getConnectionToken

public String getConnectionToken()

The authentication token associated with the participant's connection.

Returns:

The authentication token associated with the participant's connection.

withConnectionToken

public GetTranscriptRequest withConnectionToken(String connectionToken)

The authentication token associated with the participant's connection.

Parameters:

connectionToken - The authentication token associated with the participant's connection.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetTranscriptRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()