Class DescribeCasesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.support.model.SupportRequest
software.amazon.awssdk.services.support.model.DescribeCasesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeCasesRequest.Builder,DescribeCasesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeCasesRequest extends SupportRequest implements ToCopyableBuilder<DescribeCasesRequest.Builder,DescribeCasesRequest>

  • Method Details

    • hasCaseIdList

      public final boolean hasCaseIdList()
      For responses, this returns true if the service returned a value for the CaseIdList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • caseIdList

      public final List<String> caseIdList()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCaseIdList() method.

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

    • displayId

      public final String displayId()

      The ID displayed for a case in the Amazon Web Services Support Center user interface.

      Returns:
      The ID displayed for a case in the Amazon Web Services Support Center user interface.

    • afterTime

      public final String afterTime()

      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.

    • beforeTime

      public final String beforeTime()

      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.

    • includeResolvedCases

      public final Boolean includeResolvedCases()

      Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.

      Returns:
      Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.

    • nextToken

      public final String nextToken()

      A resumption point for pagination.

      Returns:
      A resumption point for pagination.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return before paginating.

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

    • language

      public final String language()

      The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

      Returns:
      The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

    • includeCommunications

      public final Boolean includeCommunications()

      Specifies whether to include communications in the DescribeCases response. By default, communications are included.

      Returns:
      Specifies whether to include communications in the DescribeCases response. By default, communications are included.

    • toBuilder

      public DescribeCasesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeCasesRequest.Builder,DescribeCasesRequest>
      Specified by:
      toBuilder in class SupportRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeCasesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeCasesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.