Class CreateCaseRequest

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.CreateCaseRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateCaseRequest.Builder,CreateCaseRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCaseRequest extends SecurityIrRequest implements ToCopyableBuilder<CreateCaseRequest.Builder,CreateCaseRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

      Returns:

      The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

    • resolverType

      public final ResolverType resolverType()

      Required element used in combination with CreateCase to identify the resolver type.

      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:
      Required element used in combination with CreateCase to identify the resolver type.
      See Also:

    • resolverTypeAsString

      public final String resolverTypeAsString()

      Required element used in combination with CreateCase to identify the resolver type.

      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:
      Required element used in combination with CreateCase to identify the resolver type.
      See Also:

    • title

      public final String title()

      Required element used in combination with CreateCase to provide a title for the new case.

      Returns:
      Required element used in combination with CreateCase to provide a title for the new case.

    • description

      public final String description()

      Required element used in combination with CreateCase

      to provide a description for the new case.

      Returns:
      Required element used in combination with CreateCase

      to provide a description for the new case.

    • engagementType

      public final EngagementType engagementType()

      Required element used in combination with CreateCase to provide an engagement type for the new cases. 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:
      Required element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation
      See Also:

    • engagementTypeAsString

      public final String engagementTypeAsString()

      Required element used in combination with CreateCase to provide an engagement type for the new cases. 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:
      Required element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation
      See Also:

    • reportedIncidentStartDate

      public final Instant reportedIncidentStartDate()

      Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity.

      Returns:
      Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity.

    • 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()

      Required element used in combination with CreateCase to provide a list of impacted accounts.

      AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

      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:
      Required element used in combination with CreateCase to provide a list of impacted accounts.

      AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

    • 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()

      Required element used in combination with CreateCase to provide a list of entities to receive notifications for case updates.

      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:
      Required element used in combination with CreateCase to provide a list of entities to receive notifications for case updates.

    • 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()

      An optional element used in combination with CreateCase to provide a list of suspicious internet protocol 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:
      An optional element used in combination with CreateCase to provide a list of suspicious internet protocol addresses associated with unauthorized activity.

    • 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()

      An optional element used in combination with CreateCase to provide a list of 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 hasImpactedServices() method.

      Returns:
      An optional element used in combination with CreateCase to provide a list of services impacted.

    • 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()

      An optional element used in combination with CreateCase to provide a list of 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:
      An optional element used in combination with CreateCase to provide a list of impacted regions.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      An optional element used in combination with CreateCase to add customer specified tags 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 hasTags() method.

      Returns:
      An optional element used in combination with CreateCase to add customer specified tags to a case.

    • toBuilder

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

    • builder

      public static CreateCaseRequest.Builder builder()

    • serializableBuilderClass

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