com.amazonaws.services.connectparticipant.model.GetTranscriptRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-connectparticipant Show documentation
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.connectparticipant.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetTranscriptRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The contactId from the current contact chain for which transcript is needed.
*
*/
private String contactId;
/**
*
* The maximum number of results to return in the page. Default: 10.
*
*/
private Integer maxResults;
/**
*
* The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set
* of results.
*
*/
private String nextToken;
/**
*
* The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is
* provided, FORWARD with StartPosition.
*
*/
private String scanDirection;
/**
*
* The sort order for the records. Default: DESCENDING.
*
*/
private String sortOrder;
/**
*
* A filtering option for where to start.
*
*/
private StartPosition startPosition;
/**
*
* The authentication token associated with the participant's connection.
*
*/
private String connectionToken;
/**
*
* The contactId from the current contact chain for which transcript is needed.
*
*
* @param contactId
* The contactId from the current contact chain for which transcript is needed.
*/
public void setContactId(String contactId) {
this.contactId = contactId;
}
/**
*
* The contactId from the current contact chain for which transcript is needed.
*
*
* @return The contactId from the current contact chain for which transcript is needed.
*/
public String getContactId() {
return this.contactId;
}
/**
*
* The contactId from the current contact chain for which transcript is needed.
*
*
* @param contactId
* The contactId from the current contact chain for which transcript is needed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTranscriptRequest withContactId(String contactId) {
setContactId(contactId);
return this;
}
/**
*
* The maximum number of results to return in the page. Default: 10.
*
*
* @param maxResults
* The maximum number of results to return in the page. Default: 10.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return in the page. Default: 10.
*
*
* @return The maximum number of results to return in the page. Default: 10.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return in the page. Default: 10.
*
*
* @param maxResults
* The maximum number of results to return in the page. Default: 10.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTranscriptRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set
* of results.
*
*
* @param nextToken
* The pagination token. Use the value returned previously in the next subsequent request to retrieve the
* next set of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set
* of results.
*
*
* @return The pagination token. Use the value returned previously in the next subsequent request to retrieve the
* next set of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set
* of results.
*
*
* @param nextToken
* The pagination token. Use the value returned previously in the next subsequent request to retrieve the
* next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTranscriptRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is
* provided, FORWARD with StartPosition.
*
*
* @param scanDirection
* The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition
* is provided, FORWARD with StartPosition.
* @see ScanDirection
*/
public void setScanDirection(String scanDirection) {
this.scanDirection = scanDirection;
}
/**
*
* The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is
* provided, FORWARD with StartPosition.
*
*
* @return The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition
* is provided, FORWARD with StartPosition.
* @see ScanDirection
*/
public String getScanDirection() {
return this.scanDirection;
}
/**
*
* The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is
* provided, FORWARD with StartPosition.
*
*
* @param scanDirection
* The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition
* is provided, FORWARD with StartPosition.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScanDirection
*/
public GetTranscriptRequest withScanDirection(String scanDirection) {
setScanDirection(scanDirection);
return this;
}
/**
*
* The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is
* provided, FORWARD with StartPosition.
*
*
* @param scanDirection
* The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition
* is provided, FORWARD with StartPosition.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScanDirection
*/
public GetTranscriptRequest withScanDirection(ScanDirection scanDirection) {
this.scanDirection = scanDirection.toString();
return this;
}
/**
*
* The sort order for the records. Default: DESCENDING.
*
*
* @param sortOrder
* The sort order for the records. Default: DESCENDING.
* @see SortKey
*/
public void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
/**
*
* The sort order for the records. Default: DESCENDING.
*
*
* @return The sort order for the records. Default: DESCENDING.
* @see SortKey
*/
public String getSortOrder() {
return this.sortOrder;
}
/**
*
* The sort order for the records. Default: DESCENDING.
*
*
* @param sortOrder
* The sort order for the records. Default: DESCENDING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortKey
*/
public GetTranscriptRequest withSortOrder(String sortOrder) {
setSortOrder(sortOrder);
return this;
}
/**
*
* The sort order for the records. Default: DESCENDING.
*
*
* @param sortOrder
* The sort order for the records. Default: DESCENDING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortKey
*/
public GetTranscriptRequest withSortOrder(SortKey sortOrder) {
this.sortOrder = sortOrder.toString();
return this;
}
/**
*
* A filtering option for where to start.
*
*
* @param startPosition
* A filtering option for where to start.
*/
public void setStartPosition(StartPosition startPosition) {
this.startPosition = startPosition;
}
/**
*
* A filtering option for where to start.
*
*
* @return A filtering option for where to start.
*/
public StartPosition getStartPosition() {
return this.startPosition;
}
/**
*
* A filtering option for where to start.
*
*
* @param startPosition
* A filtering option for where to start.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTranscriptRequest withStartPosition(StartPosition startPosition) {
setStartPosition(startPosition);
return this;
}
/**
*
* The authentication token associated with the participant's connection.
*
*
* @param connectionToken
* The authentication token associated with the participant's connection.
*/
public void setConnectionToken(String connectionToken) {
this.connectionToken = connectionToken;
}
/**
*
* The authentication token associated with the participant's connection.
*
*
* @return The authentication token associated with the participant's connection.
*/
public String getConnectionToken() {
return this.connectionToken;
}
/**
*
* The authentication token associated with the participant's connection.
*
*
* @param connectionToken
* The authentication token associated with the participant's connection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTranscriptRequest withConnectionToken(String connectionToken) {
setConnectionToken(connectionToken);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getContactId() != null)
sb.append("ContactId: ").append(getContactId()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getScanDirection() != null)
sb.append("ScanDirection: ").append(getScanDirection()).append(",");
if (getSortOrder() != null)
sb.append("SortOrder: ").append(getSortOrder()).append(",");
if (getStartPosition() != null)
sb.append("StartPosition: ").append(getStartPosition()).append(",");
if (getConnectionToken() != null)
sb.append("ConnectionToken: ").append(getConnectionToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetTranscriptRequest == false)
return false;
GetTranscriptRequest other = (GetTranscriptRequest) obj;
if (other.getContactId() == null ^ this.getContactId() == null)
return false;
if (other.getContactId() != null && other.getContactId().equals(this.getContactId()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getScanDirection() == null ^ this.getScanDirection() == null)
return false;
if (other.getScanDirection() != null && other.getScanDirection().equals(this.getScanDirection()) == false)
return false;
if (other.getSortOrder() == null ^ this.getSortOrder() == null)
return false;
if (other.getSortOrder() != null && other.getSortOrder().equals(this.getSortOrder()) == false)
return false;
if (other.getStartPosition() == null ^ this.getStartPosition() == null)
return false;
if (other.getStartPosition() != null && other.getStartPosition().equals(this.getStartPosition()) == false)
return false;
if (other.getConnectionToken() == null ^ this.getConnectionToken() == null)
return false;
if (other.getConnectionToken() != null && other.getConnectionToken().equals(this.getConnectionToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getContactId() == null) ? 0 : getContactId().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getScanDirection() == null) ? 0 : getScanDirection().hashCode());
hashCode = prime * hashCode + ((getSortOrder() == null) ? 0 : getSortOrder().hashCode());
hashCode = prime * hashCode + ((getStartPosition() == null) ? 0 : getStartPosition().hashCode());
hashCode = prime * hashCode + ((getConnectionToken() == null) ? 0 : getConnectionToken().hashCode());
return hashCode;
}
@Override
public GetTranscriptRequest clone() {
return (GetTranscriptRequest) super.clone();
}
}