com.amazonaws.services.connect.model

Class ListRulesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.ListRulesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ListRulesRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

List all rules for the specified Amazon Connect instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListRulesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEventSourceName() The name of the event source.
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
java.lang.Integer	getMaxResults() The maximum number of results to return per page.
java.lang.String	getNextToken() The token for the next set of results.
java.lang.String	getPublishStatus() The publish status of the rule.
int	hashCode()
void	setEventSourceName(EventSourceName eventSourceName) The name of the event source.
void	setEventSourceName(java.lang.String eventSourceName) The name of the event source.
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of results to return per page.
void	setNextToken(java.lang.String nextToken) The token for the next set of results.
void	setPublishStatus(RulePublishStatus publishStatus) The publish status of the rule.
void	setPublishStatus(java.lang.String publishStatus) The publish status of the rule.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListRulesRequest	withEventSourceName(EventSourceName eventSourceName) The name of the event source.
ListRulesRequest	withEventSourceName(java.lang.String eventSourceName) The name of the event source.
ListRulesRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
ListRulesRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of results to return per page.
ListRulesRequest	withNextToken(java.lang.String nextToken) The token for the next set of results.
ListRulesRequest	withPublishStatus(RulePublishStatus publishStatus) The publish status of the rule.
ListRulesRequest	withPublishStatus(java.lang.String publishStatus) The publish status of the rule.

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

ListRulesRequest

public ListRulesRequest()

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 ListRulesRequest 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.

getPublishStatus

public java.lang.String getPublishStatus()

The publish status of the rule.

Constraints:
Allowed Values: DRAFT, PUBLISHED

Returns:

The publish status of the rule.

See Also:

RulePublishStatus

setPublishStatus

public void setPublishStatus(java.lang.String publishStatus)

The publish status of the rule.

Constraints:
Allowed Values: DRAFT, PUBLISHED

Parameters:

publishStatus -

The publish status of the rule.

See Also:

RulePublishStatus

withPublishStatus

public ListRulesRequest withPublishStatus(java.lang.String publishStatus)

The publish status of the rule.

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

Constraints:
Allowed Values: DRAFT, PUBLISHED

Parameters:

publishStatus -

The publish status of the rule.

Returns:

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

See Also:

RulePublishStatus

setPublishStatus

public void setPublishStatus(RulePublishStatus publishStatus)

The publish status of the rule.

Constraints:
Allowed Values: DRAFT, PUBLISHED

Parameters:

publishStatus -

The publish status of the rule.

See Also:

RulePublishStatus

withPublishStatus

public ListRulesRequest withPublishStatus(RulePublishStatus publishStatus)

The publish status of the rule.

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

Constraints:
Allowed Values: DRAFT, PUBLISHED

Parameters:

publishStatus -

The publish status of the rule.

Returns:

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

See Also:

RulePublishStatus

getEventSourceName

public java.lang.String getEventSourceName()

The name of the event source.

Constraints:
Allowed Values: OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit

Returns:

The name of the event source.

See Also:

EventSourceName

setEventSourceName

public void setEventSourceName(java.lang.String eventSourceName)

The name of the event source.

Constraints:
Allowed Values: OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit

Parameters:

eventSourceName -

The name of the event source.

See Also:

EventSourceName

withEventSourceName

public ListRulesRequest withEventSourceName(java.lang.String eventSourceName)

The name of the event source.

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

Constraints:
Allowed Values: OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit

Parameters:

eventSourceName -

The name of the event source.

Returns:

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

See Also:

EventSourceName

setEventSourceName

public void setEventSourceName(EventSourceName eventSourceName)

The name of the event source.

Constraints:
Allowed Values: OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit

Parameters:

eventSourceName -

The name of the event source.

See Also:

EventSourceName

withEventSourceName

public ListRulesRequest withEventSourceName(EventSourceName eventSourceName)

The name of the event source.

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

Constraints:
Allowed Values: OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit

Parameters:

eventSourceName -

The name of the event source.

Returns:

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

See Also:

EventSourceName

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of results to return per page.

Constraints:
Range: 1 - 200

Returns:

The maximum number of results to return per page.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of results to return per page.

Constraints:
Range: 1 - 200

Parameters:

maxResults -

The maximum number of results to return per page.

withMaxResults

public ListRulesRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of results to return per page.

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

Constraints:
Range: 1 - 200

Parameters:

maxResults -

The maximum number of results to return per page.

Returns:

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

getNextToken

public java.lang.String getNextToken()

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

setNextToken

public void setNextToken(java.lang.String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Parameters:

nextToken -

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

withNextToken

public ListRulesRequest withNextToken(java.lang.String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

Parameters:

nextToken -

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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