software.amazon.awssdk.services.support.model

Class CaseDetails

java.lang.Object

software.amazon.awssdk.services.support.model.CaseDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CaseDetails.Builder,CaseDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class CaseDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CaseDetails.Builder,CaseDetails>

A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:

• caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.

• categoryCode - The category of problem for the support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.

• displayId - The identifier for the case on pages in the Amazon Web Services Support Center.

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

• nextToken - A resumption point for pagination.

• recentCommunications - One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.

• serviceCode - The identifier for the Amazon Web Services service that corresponds to the service code defined in the call to DescribeServices.

• severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical.

• status - The status of the case in the Amazon Web Services Support Center. Valid values:

  • opened

  • pending-customer-action

  • reopened

  • resolved

  • unassigned

  • work-in-progress

• subject - The subject line of the case.

• submittedBy - The email address of the account that submitted the case.

• timeCreated - The time the case was created, in ISO-8601 format.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CaseDetails.Builder

Method Summary

Modifier and Type	Method and Description
static CaseDetails.Builder	builder()
String	caseId() The support case ID requested or returned in the call.
String	categoryCode() The category of problem for the support case.
List<String>	ccEmailAddresses() The email addresses that receive copies of communication about the case.
String	displayId() The ID displayed for the case in the Amazon Web Services Support Center.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCcEmailAddresses() For responses, this returns true if the service returned a value for the CcEmailAddresses property.
int	hashCode()
String	language() The language in which Amazon Web Services Support handles the case.
RecentCaseCommunications	recentCommunications() The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications.
List<SdkField<?>>	sdkFields()
static Class<? extends CaseDetails.Builder>	serializableBuilderClass()
String	serviceCode() The code for the Amazon Web Services service.
String	severityCode() The code for the severity level returned by the call to DescribeSeverityLevels.
String	status() The status of the case.
String	subject() The subject line for the case in the Amazon Web Services Support Center.
String	submittedBy() The email address of the account that submitted the case.
String	timeCreated() The time that the case was created in the Amazon Web Services Support Center.
CaseDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

caseId

public final String caseId()

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

Returns:

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

displayId

public final String displayId()

The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

Returns:

The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

subject

public final String subject()

The subject line for the case in the Amazon Web Services Support Center.

Returns:

The subject line for the case in the Amazon Web Services Support Center.

status

public final String status()

The status of the case.

Valid values:

• opened

• pending-customer-action

• reopened

• resolved

• unassigned

• work-in-progress

Returns:

The status of the case.

Valid values:

• opened

• pending-customer-action

• reopened

• resolved

• unassigned

• work-in-progress

serviceCode

public final String serviceCode()

The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

Returns:

The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

categoryCode

public final String categoryCode()

The category of problem for the support case.

Returns:

The category of problem for the support case.

severityCode

public final String severityCode()

The code for the severity level returned by the call to DescribeSeverityLevels.

Returns:

The code for the severity level returned by the call to DescribeSeverityLevels.

submittedBy

public final String submittedBy()

The email address of the account that submitted the case.

Returns:

The email address of the account that submitted the case.

timeCreated

public final String timeCreated()

The time that the case was created in the Amazon Web Services Support Center.

Returns:

The time that the case was created in the Amazon Web Services Support Center.

recentCommunications

public final RecentCaseCommunications recentCommunications()

The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

Returns:

The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

hasCcEmailAddresses

public final boolean hasCcEmailAddresses()

For responses, this returns true if the service returned a value for the CcEmailAddresses 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.

ccEmailAddresses

public final List<String> ccEmailAddresses()

The email addresses that receive copies of communication about the case.

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 hasCcEmailAddresses() method.

Returns:

The email addresses that receive copies of communication about the case.

language

public final String language()

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). 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 English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

toBuilder

public CaseDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CaseDetails.Builder,CaseDetails>

builder

public static CaseDetails.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo