Class DescribeCasesRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.support.model.DescribeCasesRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeCasesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • DescribeCasesRequest

      public DescribeCasesRequest()
  • Method Details

    • getCaseIdList

      public List<String> getCaseIdList()

      A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

      Returns:
      A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
    • setCaseIdList

      public void setCaseIdList(Collection<String> caseIdList)

      A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

      Parameters:
      caseIdList - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
    • withCaseIdList

      public DescribeCasesRequest withCaseIdList(String... caseIdList)

      A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

      NOTE: This method appends the values to the existing list (if any). Use setCaseIdList(java.util.Collection) or withCaseIdList(java.util.Collection) if you want to override the existing values.

      Parameters:
      caseIdList - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withCaseIdList

      public DescribeCasesRequest withCaseIdList(Collection<String> caseIdList)

      A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

      Parameters:
      caseIdList - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDisplayId

      public void setDisplayId(String displayId)

      The ID displayed for a case in the AWS Support Center user interface.

      Parameters:
      displayId - The ID displayed for a case in the AWS Support Center user interface.
    • getDisplayId

      public String getDisplayId()

      The ID displayed for a case in the AWS Support Center user interface.

      Returns:
      The ID displayed for a case in the AWS Support Center user interface.
    • withDisplayId

      public DescribeCasesRequest withDisplayId(String displayId)

      The ID displayed for a case in the AWS Support Center user interface.

      Parameters:
      displayId - The ID displayed for a case in the AWS Support Center user interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAfterTime

      public void setAfterTime(String afterTime)

      The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

      Parameters:
      afterTime - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
    • getAfterTime

      public String getAfterTime()

      The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

      Returns:
      The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
    • withAfterTime

      public DescribeCasesRequest withAfterTime(String afterTime)

      The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

      Parameters:
      afterTime - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setBeforeTime

      public void setBeforeTime(String beforeTime)

      The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

      Parameters:
      beforeTime - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
    • getBeforeTime

      public String getBeforeTime()

      The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

      Returns:
      The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
    • withBeforeTime

      public DescribeCasesRequest withBeforeTime(String beforeTime)

      The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

      Parameters:
      beforeTime - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIncludeResolvedCases

      public void setIncludeResolvedCases(Boolean includeResolvedCases)

      Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

      Parameters:
      includeResolvedCases - Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
    • getIncludeResolvedCases

      public Boolean getIncludeResolvedCases()

      Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

      Returns:
      Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
    • withIncludeResolvedCases

      public DescribeCasesRequest withIncludeResolvedCases(Boolean includeResolvedCases)

      Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

      Parameters:
      includeResolvedCases - Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isIncludeResolvedCases

      public Boolean isIncludeResolvedCases()

      Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

      Returns:
      Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
    • setNextToken

      public void setNextToken(String nextToken)

      A resumption point for pagination.

      Parameters:
      nextToken - A resumption point for pagination.
    • getNextToken

      public String getNextToken()

      A resumption point for pagination.

      Returns:
      A resumption point for pagination.
    • withNextToken

      public DescribeCasesRequest withNextToken(String nextToken)

      A resumption point for pagination.

      Parameters:
      nextToken - A resumption point for pagination.
      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 before paginating.

      Parameters:
      maxResults - The maximum number of results to return before paginating.
    • getMaxResults

      public Integer getMaxResults()

      The maximum number of results to return before paginating.

      Returns:
      The maximum number of results to return before paginating.
    • withMaxResults

      public DescribeCasesRequest withMaxResults(Integer maxResults)

      The maximum number of results to return before paginating.

      Parameters:
      maxResults - The maximum number of results to return before paginating.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLanguage

      public void setLanguage(String language)

      The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

      Parameters:
      language - The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
    • getLanguage

      public String getLanguage()

      The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

      Returns:
      The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
    • withLanguage

      public DescribeCasesRequest withLanguage(String language)

      The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

      Parameters:
      language - The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIncludeCommunications

      public void setIncludeCommunications(Boolean includeCommunications)

      Specifies whether communications should be included in the DescribeCases results. The default is true.

      Parameters:
      includeCommunications - Specifies whether communications should be included in the DescribeCases results. The default is true.
    • getIncludeCommunications

      public Boolean getIncludeCommunications()

      Specifies whether communications should be included in the DescribeCases results. The default is true.

      Returns:
      Specifies whether communications should be included in the DescribeCases results. The default is true.
    • withIncludeCommunications

      public DescribeCasesRequest withIncludeCommunications(Boolean includeCommunications)

      Specifies whether communications should be included in the DescribeCases results. The default is true.

      Parameters:
      includeCommunications - Specifies whether communications should be included in the DescribeCases results. The default is true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isIncludeCommunications

      public Boolean isIncludeCommunications()

      Specifies whether communications should be included in the DescribeCases results. The default is true.

      Returns:
      Specifies whether communications should be included in the DescribeCases results. The default is true.
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeCasesRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: