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

Interface CreateClassificationJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateClassificationJobRequest.Builder,CreateClassificationJobRequest>, Macie2Request.Builder, SdkBuilder<CreateClassificationJobRequest.Builder,CreateClassificationJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateClassificationJobRequest
public static interface CreateClassificationJobRequest.Builder extends Macie2Request.Builder, SdkPojo, CopyableBuilder<CreateClassificationJobRequest.Builder,CreateClassificationJobRequest>

  • Method Details

    • allowListIds

      CreateClassificationJobRequest.Builder allowListIds(Collection<String> allowListIds)

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

      Parameters:
      allowListIds - An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowListIds

      CreateClassificationJobRequest.Builder allowListIds(String... allowListIds)

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

      Parameters:
      allowListIds - An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateClassificationJobRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDataIdentifierIds

      CreateClassificationJobRequest.Builder customDataIdentifierIds(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDataIdentifierIds

      CreateClassificationJobRequest.Builder customDataIdentifierIds(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateClassificationJobRequest.Builder description(String description)

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

      Parameters:
      description - A custom description of the job. The description can contain as many as 200 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialRun

      CreateClassificationJobRequest.Builder initialRun(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • jobType

      CreateClassificationJobRequest.Builder jobType(String 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 define the recurrence pattern for the job.

      Parameters:
      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 define the recurrence pattern for the job.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobType

      CreateClassificationJobRequest.Builder jobType(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 define the recurrence pattern for the job.

      Parameters:
      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 define the recurrence pattern for the job.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • managedDataIdentifierIds

      CreateClassificationJobRequest.Builder managedDataIdentifierIds(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedDataIdentifierIds

      CreateClassificationJobRequest.Builder managedDataIdentifierIds(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedDataIdentifierSelector

      CreateClassificationJobRequest.Builder managedDataIdentifierSelector(String 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 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.

      For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

      Parameters:
      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 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.

      For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • managedDataIdentifierSelector

      CreateClassificationJobRequest.Builder managedDataIdentifierSelector(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 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.

      For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

      Parameters:
      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 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.

      For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      CreateClassificationJobRequest.Builder name(String name)

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

      Parameters:
      name - A custom name for the job. The name can contain as many as 500 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3JobDefinition

      CreateClassificationJobRequest.Builder s3JobDefinition(S3JobDefinition s3JobDefinition)

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

      Parameters:
      s3JobDefinition - The S3 buckets that contain the objects to analyze, and the scope of that analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3JobDefinition

      default CreateClassificationJobRequest.Builder s3JobDefinition(Consumer<S3JobDefinition.Builder> s3JobDefinition)

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

      This is a convenience method that creates an instance of the S3JobDefinition.Builder avoiding the need to create one manually via S3JobDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3JobDefinition(S3JobDefinition).

      Parameters:
      s3JobDefinition - a consumer that will call methods on S3JobDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • samplingPercentage

      CreateClassificationJobRequest.Builder samplingPercentage(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleFrequency

      CreateClassificationJobRequest.Builder scheduleFrequency(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleFrequency

      default CreateClassificationJobRequest.Builder scheduleFrequency(Consumer<JobScheduleFrequency.Builder> 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.

      This is a convenience method that creates an instance of the JobScheduleFrequency.Builder avoiding the need to create one manually via JobScheduleFrequency.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scheduleFrequency(JobScheduleFrequency).

      Parameters:
      scheduleFrequency - a consumer that will call methods on JobScheduleFrequency.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateClassificationJobRequest.Builder tags(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateClassificationJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateClassificationJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.