Class GetCaseResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.securityir.model.SecurityIrResponse
software.amazon.awssdk.services.securityir.model.GetCaseResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCaseResponse.Builder,GetCaseResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetCaseResponse extends SecurityIrResponse implements ToCopyableBuilder<GetCaseResponse.Builder,GetCaseResponse>

  • Method Details

    • title

      public final String title()

      Response element for GetCase that provides the case title.

      Returns:
      Response element for GetCase that provides the case title.

    • caseArn

      public final String caseArn()

      Response element for GetCase that provides the case ARN

      Returns:
      Response element for GetCase that provides the case ARN

    • description

      public final String description()

      Response element for GetCase that provides contents of the case description.

      Returns:
      Response element for GetCase that provides contents of the case description.

    • caseStatus

      public final CaseStatus caseStatus()

      Response element for GetCase that provides the case status. Options for statuses include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed

      If the service returns an enum value that is not available in the current SDK version, caseStatus will return CaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from caseStatusAsString().

      Returns:
      Response element for GetCase that provides the case status. Options for statuses include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed
      See Also:

    • caseStatusAsString

      public final String caseStatusAsString()

      Response element for GetCase that provides the case status. Options for statuses include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed

      If the service returns an enum value that is not available in the current SDK version, caseStatus will return CaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from caseStatusAsString().

      Returns:
      Response element for GetCase that provides the case status. Options for statuses include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed
      See Also:

    • engagementType

      public final EngagementType engagementType()

      Response element for GetCase that provides the engagement type. Options for engagement type include Active Security Event | Investigations

      If the service returns an enum value that is not available in the current SDK version, engagementType will return EngagementType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engagementTypeAsString().

      Returns:
      Response element for GetCase that provides the engagement type. Options for engagement type include Active Security Event | Investigations
      See Also:

    • engagementTypeAsString

      public final String engagementTypeAsString()

      Response element for GetCase that provides the engagement type. Options for engagement type include Active Security Event | Investigations

      If the service returns an enum value that is not available in the current SDK version, engagementType will return EngagementType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engagementTypeAsString().

      Returns:
      Response element for GetCase that provides the engagement type. Options for engagement type include Active Security Event | Investigations
      See Also:

    • reportedIncidentStartDate

      public final Instant reportedIncidentStartDate()

      Response element for GetCase that provides the customer provided incident start date.

      Returns:
      Response element for GetCase that provides the customer provided incident start date.

    • actualIncidentStartDate

      public final Instant actualIncidentStartDate()

      Response element for GetCase that provides the actual incident start date as identified by data analysis during the investigation.

      Returns:
      Response element for GetCase that provides the actual incident start date as identified by data analysis during the investigation.

    • hasImpactedAwsRegions

      public final boolean hasImpactedAwsRegions()
      For responses, this returns true if the service returned a value for the ImpactedAwsRegions 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.

    • impactedAwsRegions

      public final List<ImpactedAwsRegion> impactedAwsRegions()

      Response element for GetCase that provides the impacted regions.

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

      Returns:
      Response element for GetCase that provides the impacted regions.

    • hasThreatActorIpAddresses

      public final boolean hasThreatActorIpAddresses()
      For responses, this returns true if the service returned a value for the ThreatActorIpAddresses 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.

    • threatActorIpAddresses

      public final List<ThreatActorIp> threatActorIpAddresses()

      Response element for GetCase that provides a list of suspicious IP addresses associated with unauthorized activity.

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

      Returns:
      Response element for GetCase that provides a list of suspicious IP addresses associated with unauthorized activity.

    • pendingAction

      public final PendingAction pendingAction()

      Response element for GetCase that provides identifies the case is waiting on customer input.

      If the service returns an enum value that is not available in the current SDK version, pendingAction will return PendingAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pendingActionAsString().

      Returns:
      Response element for GetCase that provides identifies the case is waiting on customer input.
      See Also:

    • pendingActionAsString

      public final String pendingActionAsString()

      Response element for GetCase that provides identifies the case is waiting on customer input.

      If the service returns an enum value that is not available in the current SDK version, pendingAction will return PendingAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pendingActionAsString().

      Returns:
      Response element for GetCase that provides identifies the case is waiting on customer input.
      See Also:

    • hasImpactedAccounts

      public final boolean hasImpactedAccounts()
      For responses, this returns true if the service returned a value for the ImpactedAccounts 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.

    • impactedAccounts

      public final List<String> impactedAccounts()

      Response element for GetCase that provides a list of impacted accounts.

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

      Returns:
      Response element for GetCase that provides a list of impacted accounts.

    • hasWatchers

      public final boolean hasWatchers()
      For responses, this returns true if the service returned a value for the Watchers 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.

    • watchers

      public final List<Watcher> watchers()

      Response element for GetCase that provides a list of Watchers added to 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 hasWatchers() method.

      Returns:
      Response element for GetCase that provides a list of Watchers added to the case.

    • createdDate

      public final Instant createdDate()

      Response element for GetCase that provides the date the case was created.

      Returns:
      Response element for GetCase that provides the date the case was created.

    • lastUpdatedDate

      public final Instant lastUpdatedDate()

      Response element for GetCase that provides the date a case was last modified.

      Returns:
      Response element for GetCase that provides the date a case was last modified.

    • closureCode

      public final ClosureCode closureCode()

      Response element for GetCase that provides the summary code for why a case was closed.

      If the service returns an enum value that is not available in the current SDK version, closureCode will return ClosureCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from closureCodeAsString().

      Returns:
      Response element for GetCase that provides the summary code for why a case was closed.
      See Also:

    • closureCodeAsString

      public final String closureCodeAsString()

      Response element for GetCase that provides the summary code for why a case was closed.

      If the service returns an enum value that is not available in the current SDK version, closureCode will return ClosureCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from closureCodeAsString().

      Returns:
      Response element for GetCase that provides the summary code for why a case was closed.
      See Also:

    • resolverType

      public final ResolverType resolverType()

      Response element for GetCase that provides the current resolver types. Options include self-supported | AWS-supported.

      If the service returns an enum value that is not available in the current SDK version, resolverType will return ResolverType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resolverTypeAsString().

      Returns:
      Response element for GetCase that provides the current resolver types. Options include self-supported | AWS-supported.
      See Also:

    • resolverTypeAsString

      public final String resolverTypeAsString()

      Response element for GetCase that provides the current resolver types. Options include self-supported | AWS-supported.

      If the service returns an enum value that is not available in the current SDK version, resolverType will return ResolverType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resolverTypeAsString().

      Returns:
      Response element for GetCase that provides the current resolver types. Options include self-supported | AWS-supported.
      See Also:

    • hasImpactedServices

      public final boolean hasImpactedServices()
      For responses, this returns true if the service returned a value for the ImpactedServices 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.

    • impactedServices

      public final List<String> impactedServices()

      Response element for GetCase that provides a list of impacted services.

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

      Returns:
      Response element for GetCase that provides a list of impacted services.

    • hasCaseAttachments

      public final boolean hasCaseAttachments()
      For responses, this returns true if the service returned a value for the CaseAttachments 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.

    • caseAttachments

      public final List<CaseAttachmentAttributes> caseAttachments()

      Response element for GetCase that provides a list of current case attachments.

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

      Returns:
      Response element for GetCase that provides a list of current case attachments.

    • closedDate

      public final Instant closedDate()

      Response element for GetCase that provides the date a specified case was closed.

      Returns:
      Response element for GetCase that provides the date a specified case was closed.

    • toBuilder

      public GetCaseResponse.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<GetCaseResponse.Builder,GetCaseResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetCaseResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.