Class UpdateCaseRequest

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

  • Method Details

    • caseId

      public final String caseId()

      Required element for UpdateCase to identify the case ID for updates.

      Returns:
      Required element for UpdateCase to identify the case ID for updates.

    • title

      public final String title()

      Optional element for UpdateCase to provide content for the title field.

      Returns:
      Optional element for UpdateCase to provide content for the title field.

    • description

      public final String description()

      Optional element for UpdateCase to provide content for the description field.

      Returns:
      Optional element for UpdateCase to provide content for the description field.

    • reportedIncidentStartDate

      public final Instant reportedIncidentStartDate()

      Optional element for UpdateCase to provide content for the customer reported incident start date field.

      Returns:
      Optional element for UpdateCase to provide content for the customer reported incident start date field.

    • actualIncidentStartDate

      public final Instant actualIncidentStartDate()

      Optional element for UpdateCase to provide content for the incident start date field.

      Returns:
      Optional element for UpdateCase to provide content for the incident start date field.

    • engagementType

      public final EngagementType engagementType()

      Optional element for UpdateCase to provide content for the engagement type field. Available engagement types include Security Incident | Investigation.

      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:
      Optional element for UpdateCase to provide content for the engagement type field. Available engagement types include Security Incident | Investigation.
      See Also:

    • engagementTypeAsString

      public final String engagementTypeAsString()

      Optional element for UpdateCase to provide content for the engagement type field. Available engagement types include Security Incident | Investigation.

      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:
      Optional element for UpdateCase to provide content for the engagement type field. Available engagement types include Security Incident | Investigation.
      See Also:

    • hasWatchersToAdd

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

    • watchersToAdd

      public final List<Watcher> watchersToAdd()

      Optional element for UpdateCase to provide content to add additional watchers to a 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 hasWatchersToAdd() method.

      Returns:
      Optional element for UpdateCase to provide content to add additional watchers to a case.

    • hasWatchersToDelete

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

    • watchersToDelete

      public final List<Watcher> watchersToDelete()

      Optional element for UpdateCase to provide content to remove existing watchers from a 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 hasWatchersToDelete() method.

      Returns:
      Optional element for UpdateCase to provide content to remove existing watchers from a case.

    • hasThreatActorIpAddressesToAdd

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

    • threatActorIpAddressesToAdd

      public final List<ThreatActorIp> threatActorIpAddressesToAdd()

      Optional element for UpdateCase to provide content to add additional suspicious IP addresses related to a 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 hasThreatActorIpAddressesToAdd() method.

      Returns:
      Optional element for UpdateCase to provide content to add additional suspicious IP addresses related to a case.

    • hasThreatActorIpAddressesToDelete

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

    • threatActorIpAddressesToDelete

      public final List<ThreatActorIp> threatActorIpAddressesToDelete()

      Optional element for UpdateCase to provide content to remove suspicious IP addresses from a 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 hasThreatActorIpAddressesToDelete() method.

      Returns:
      Optional element for UpdateCase to provide content to remove suspicious IP addresses from a case.

    • hasImpactedServicesToAdd

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

    • impactedServicesToAdd

      public final List<String> impactedServicesToAdd()

      Optional element for UpdateCase to provide content to add services impacted.

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

      Returns:
      Optional element for UpdateCase to provide content to add services impacted.

    • hasImpactedServicesToDelete

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

    • impactedServicesToDelete

      public final List<String> impactedServicesToDelete()

      Optional element for UpdateCase to provide content to remove services impacted.

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

      Returns:
      Optional element for UpdateCase to provide content to remove services impacted.

    • hasImpactedAwsRegionsToAdd

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

    • impactedAwsRegionsToAdd

      public final List<ImpactedAwsRegion> impactedAwsRegionsToAdd()

      Optional element for UpdateCase to provide content to add regions impacted.

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

      Returns:
      Optional element for UpdateCase to provide content to add regions impacted.

    • hasImpactedAwsRegionsToDelete

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

    • impactedAwsRegionsToDelete

      public final List<ImpactedAwsRegion> impactedAwsRegionsToDelete()

      Optional element for UpdateCase to provide content to remove regions impacted.

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

      Returns:
      Optional element for UpdateCase to provide content to remove regions impacted.

    • hasImpactedAccountsToAdd

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

    • impactedAccountsToAdd

      public final List<String> impactedAccountsToAdd()

      Optional element for UpdateCase to provide content to add accounts impacted.

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

      Returns:
      Optional element for UpdateCase to provide content to add accounts impacted.

    • hasImpactedAccountsToDelete

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

    • impactedAccountsToDelete

      public final List<String> impactedAccountsToDelete()

      Optional element for UpdateCase to provide content to add accounts impacted.

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

      Returns:
      Optional element for UpdateCase to provide content to add accounts impacted.

    • toBuilder

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

    • builder

      public static UpdateCaseRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateCaseRequest.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.

    • sdkFieldNameToField

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