Package software.amazon.awssdk.services.macie2.model

Class CreateClassificationJobRequest

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

  • Method Details

    • hasAllowListIds

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

    • allowListIds

      public final List<String> allowListIds()

      An array of unique identifiers, one for each allow list for the job to use when it analyzes data.

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

      Returns:
      An array of unique identifiers, one for each allow list for the job to use when it analyzes data.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      Returns:
      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

    • hasCustomDataIdentifierIds

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

    • customDataIdentifierIds

      public final List<String> customDataIdentifierIds()

      An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

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

      Returns:
      An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

    • description

      public final String description()

      A custom description of the job. The description can contain as many as 200 characters.

      Returns:
      A custom description of the job. The description can contain as many as 200 characters.

    • initialRun

      public final Boolean initialRun()

      For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

      If you configure the job to run only once, don't specify a value for this property.

      Returns:
      For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

      If you configure the job to run only once, don't specify a value for this property.

    • jobType

      public final JobType jobType()

      The schedule for running the job. Valid values are:

      • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

      • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.

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

      Returns:
      The schedule for running the job. Valid values are:

      • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

      • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.

      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The schedule for running the job. Valid values are:

      • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

      • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.

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

      Returns:
      The schedule for running the job. Valid values are:

      • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

      • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.

      See Also:

    • hasManagedDataIdentifierIds

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

    • managedDataIdentifierIds

      public final List<String> managedDataIdentifierIds()

      An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

      To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

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

      Returns:
      An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

      To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

    • managedDataIdentifierSelector

      public final ManagedDataIdentifierSelector managedDataIdentifierSelector()

      The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

      • ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      • EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.

      • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

      • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.

      • RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.

      If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.

      To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.

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

      Returns:
      The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

      • ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      • EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.

      • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

      • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.

      • RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.

      If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.

      To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.

      See Also:

    • managedDataIdentifierSelectorAsString

      public final String managedDataIdentifierSelectorAsString()

      The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

      • ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      • EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.

      • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

      • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.

      • RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.

      If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.

      To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.

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

      Returns:
      The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

      • ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      • EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.

      • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

      • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.

      • RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.

      If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.

      To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.

      See Also:

    • name

      public final String name()

      A custom name for the job. The name can contain as many as 500 characters.

      Returns:
      A custom name for the job. The name can contain as many as 500 characters.

    • s3JobDefinition

      public final S3JobDefinition s3JobDefinition()

      The S3 buckets that contain the objects to analyze, and the scope of that analysis.

      Returns:
      The S3 buckets that contain the objects to analyze, and the scope of that analysis.

    • samplingPercentage

      public final Integer samplingPercentage()

      The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

      Returns:
      The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

    • scheduleFrequency

      public final JobScheduleFrequency scheduleFrequency()

      The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.

      Returns:
      The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.

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

      A map of key-value pairs that specifies the tags to associate with the job.

      A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

      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:
      A map of key-value pairs that specifies the tags to associate with the job.

      A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

    • toBuilder

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

    • builder

      public static CreateClassificationJobRequest.Builder builder()

    • serializableBuilderClass

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