DescribeCommunicationsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.support.model.DescribeCommunicationsRequest

All Implemented Interfaces:

Serializable
```
public class DescribeCommunicationsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DescribeCommunications operation.
This action returns communications regarding the support case. You can use the AfterTime and BeforeTime parameters to filter by date. The CaseId parameter enables you to identify a specific case by its CaseId number.

The MaxResults and NextToken parameters enable you to control the pagination of the result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

See Also:
AWSSupport.describeCommunications(DescribeCommunicationsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeCommunicationsRequest()

Constructors
Constructor and Description
`DescribeCommunicationsRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAfterTime()` Start date for a filtered date search on support case communications.
`String`	`getBeforeTime()` End date for a filtered date search on support case communications.
`String`	`getCaseId()` String that indicates the AWS Support caseID requested or returned in the call.
`Integer`	`getMaxResults()` Integer that sets the maximum number of results to return before paginating.
`String`	`getNextToken()` Defines a resumption point for pagination.
`int`	`hashCode()`
`void`	`setAfterTime(String afterTime)` Start date for a filtered date search on support case communications.
`void`	`setBeforeTime(String beforeTime)` End date for a filtered date search on support case communications.
`void`	`setCaseId(String caseId)` String that indicates the AWS Support caseID requested or returned in the call.
`void`	`setMaxResults(Integer maxResults)` Integer that sets the maximum number of results to return before paginating.
`void`	`setNextToken(String nextToken)` Defines a resumption point for pagination.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeCommunicationsRequest`	`withAfterTime(String afterTime)` Start date for a filtered date search on support case communications.
`DescribeCommunicationsRequest`	`withBeforeTime(String beforeTime)` End date for a filtered date search on support case communications.
`DescribeCommunicationsRequest`	`withCaseId(String caseId)` String that indicates the AWS Support caseID requested or returned in the call.
`DescribeCommunicationsRequest`	`withMaxResults(Integer maxResults)` Integer that sets the maximum number of results to return before paginating.
`DescribeCommunicationsRequest`	`withNextToken(String nextToken)` Defines a resumption point for pagination.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

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

- Constructor Detail
  - DescribeCommunicationsRequest
```
public DescribeCommunicationsRequest()
```
- Method Detail
  - getCaseId
```
public String getCaseId()
```
    String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47
    
    Returns:
    String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47
  - setCaseId
```
public void setCaseId(String caseId)
```
    String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47
    
    Parameters:
    caseId - String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47
  - withCaseId
```
public DescribeCommunicationsRequest withCaseId(String caseId)
```
    String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    caseId - String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getBeforeTime
```
public String getBeforeTime()
```
    End date for a filtered date search on support case communications.
    
    Returns:
    End date for a filtered date search on support case communications.
  - setBeforeTime
```
public void setBeforeTime(String beforeTime)
```
    End date for a filtered date search on support case communications.
    
    Parameters:
    beforeTime - End date for a filtered date search on support case communications.
  - withBeforeTime
```
public DescribeCommunicationsRequest withBeforeTime(String beforeTime)
```
    End date for a filtered date search on support case communications.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    beforeTime - End date for a filtered date search on support case communications.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAfterTime
```
public String getAfterTime()
```
    Start date for a filtered date search on support case communications.
    
    Returns:
    Start date for a filtered date search on support case communications.
  - setAfterTime
```
public void setAfterTime(String afterTime)
```
    Start date for a filtered date search on support case communications.
    
    Parameters:
    afterTime - Start date for a filtered date search on support case communications.
  - withAfterTime
```
public DescribeCommunicationsRequest withAfterTime(String afterTime)
```
    Start date for a filtered date search on support case communications.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    afterTime - Start date for a filtered date search on support case communications.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public String getNextToken()
```
    Defines a resumption point for pagination.
    
    Returns:
    Defines a resumption point for pagination.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    Defines a resumption point for pagination.
    
    Parameters:
    nextToken - Defines a resumption point for pagination.
  - withNextToken
```
public DescribeCommunicationsRequest withNextToken(String nextToken)
```
    Defines a resumption point for pagination.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    nextToken - Defines a resumption point for pagination.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public Integer getMaxResults()
```
    Integer that sets the maximum number of results to return before paginating.
    Constraints:
    Range: 10 - 100
    
    Returns:
    Integer that sets the maximum number of results to return before paginating.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    Integer that sets the maximum number of results to return before paginating.
    Constraints:
    Range: 10 - 100
    
    Parameters:
    maxResults - Integer that sets the maximum number of results to return before paginating.
  - withMaxResults
```
public DescribeCommunicationsRequest withMaxResults(Integer maxResults)
```
    Integer that sets the maximum number of results to return before paginating.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 10 - 100
    
    Parameters:
    maxResults - Integer that sets the maximum number of results to return before paginating.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DescribeCommunicationsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeCommunicationsRequest

Method Detail

getCaseId

setCaseId

withCaseId

getBeforeTime

setBeforeTime

withBeforeTime

getAfterTime

setAfterTime

withAfterTime

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

toString

hashCode

equals