/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.macie2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateClassificationJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* An array of unique identifiers, one for each allow list for the job to use when it analyzes data. *
*/ private java.util.List* A unique, case-sensitive token that you provide to ensure the idempotency of the request. *
*/ private String clientToken; /** ** 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. *
*/ private java.util.List* A custom description of the job. The description can contain as many as 200 characters. *
*/ private String description; /** ** 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. *
*/ private Boolean initialRun; /** ** 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. *
** 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. *
*/ private java.util.List* The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid * values are: *
** ALL (default) - 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 custom data * identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds * property. *
** RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. 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 all managed data identifiers. *
** If the job is a recurring job and you don't specify a value for this property or 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 job starts to run. *
** 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. *
*/ private String managedDataIdentifierSelector; /** ** A custom name for the job. The name can contain as many as 500 characters. *
*/ private String name; /** ** The S3 buckets that contain the objects to analyze, and the scope of that analysis. *
*/ private S3JobDefinition s3JobDefinition; /** ** 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. *
*/ private Integer samplingPercentage; /** ** 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. *
*/ private JobScheduleFrequency scheduleFrequency; /** ** 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. *
*/ private java.util.Map* An array of unique identifiers, one for each allow list for the job to use when it analyzes data. *
* * @return An array of unique identifiers, one for each allow list for the job to use when it analyzes data. */ public java.util.List* An array of unique identifiers, one for each allow list for the job to use when it analyzes data. *
* * @param allowListIds * An array of unique identifiers, one for each allow list for the job to use when it analyzes data. */ public void setAllowListIds(java.util.Collection* An array of unique identifiers, one for each allow list for the job to use when it analyzes data. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setAllowListIds(java.util.Collection)} or {@link #withAllowListIds(java.util.Collection)} if you want to * override the existing values. *
* * @param allowListIds * An array of unique identifiers, one for each allow list for the job to use when it analyzes data. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withAllowListIds(String... allowListIds) { if (this.allowListIds == null) { setAllowListIds(new java.util.ArrayList* An array of unique identifiers, one for each allow list for the job to use when it analyzes data. *
* * @param allowListIds * An array of unique identifiers, one for each allow list for the job to use when it analyzes data. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withAllowListIds(java.util.Collection* A unique, case-sensitive token that you provide to ensure the idempotency of the request. *
* * @param clientToken * A unique, case-sensitive token that you provide to ensure the idempotency of the request. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** ** A unique, case-sensitive token that you provide to ensure the idempotency of the request. *
* * @return A unique, case-sensitive token that you provide to ensure the idempotency of the request. */ public String getClientToken() { return this.clientToken; } /** ** A unique, case-sensitive token that you provide to ensure the idempotency of the request. *
* * @param clientToken * A unique, case-sensitive token that you provide to ensure the idempotency of the request. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** ** 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setCustomDataIdentifierIds(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setCustomDataIdentifierIds(java.util.Collection)} or * {@link #withCustomDataIdentifierIds(java.util.Collection)} if you want to override the existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withCustomDataIdentifierIds(String... customDataIdentifierIds) { if (this.customDataIdentifierIds == null) { setCustomDataIdentifierIds(new java.util.ArrayList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withCustomDataIdentifierIds(java.util.Collection* A custom description of the job. The description can contain as many as 200 characters. *
* * @param description * A custom description of the job. The description can contain as many as 200 characters. */ public void setDescription(String description) { this.description = description; } /** ** A custom description of the job. The description can contain as many as 200 characters. *
* * @return A custom description of the job. The description can contain as many as 200 characters. */ public String getDescription() { return this.description; } /** ** A custom description of the job. The description can contain as many as 200 characters. *
* * @param description * A custom description of the job. The description can contain as many as 200 characters. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withDescription(String description) { setDescription(description); return this; } /** ** 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. *
* * @param 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. */ public void setInitialRun(Boolean initialRun) { this.initialRun = 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. *
* * @return 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. */ public Boolean getInitialRun() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withInitialRun(Boolean initialRun) { setInitialRun(initialRun); return this; } /** *
* 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. *
* * @return 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. */ public Boolean isInitialRun() { return this.initialRun; } /** *
* 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
* * @return 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.
*/
public java.util.List
* 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.
*
* To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
*/
public void setManagedDataIdentifierIds(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setManagedDataIdentifierIds(java.util.Collection)} or
* {@link #withManagedDataIdentifierIds(java.util.Collection)} if you want to override the existing values.
*
* To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateClassificationJobRequest withManagedDataIdentifierIds(String... managedDataIdentifierIds) {
if (this.managedDataIdentifierIds == null) {
setManagedDataIdentifierIds(new java.util.ArrayList
* 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.
*
* To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateClassificationJobRequest withManagedDataIdentifierIds(java.util.Collection
* The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid
* values are:
*
* ALL (default) - 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 custom data
* identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds
* property.
*
* RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. 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 all managed data identifiers.
*
* If the job is a recurring job and you don't specify a value for this property or 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 job starts to run.
*
* 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.
*
*
*
* ALL (default) - 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 custom data * identifier for the job (customDataIdentifierIds) and don't specify any values for the * managedDataIdentifierIds property. *
** RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. * 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 all managed data identifiers. *
** If the job is a recurring job and you don't specify a value for this property or 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 job starts to run. *
** 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. * @see ManagedDataIdentifierSelector */ public void setManagedDataIdentifierSelector(String managedDataIdentifierSelector) { this.managedDataIdentifierSelector = managedDataIdentifierSelector; } /** *
* The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid * values are: *
** ALL (default) - 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 custom data * identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds * property. *
** RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. 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 all managed data identifiers. *
** If the job is a recurring job and you don't specify a value for this property or 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 job starts to run. *
** 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. *
* * @return The selection type to apply when determining which managed data identifiers the job uses to analyze data. * Valid values are: ** ALL (default) - 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 custom * data identifier for the job (customDataIdentifierIds) and don't specify any values for the * managedDataIdentifierIds property. *
** RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. * 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 all managed data identifiers. *
** If the job is a recurring job and you don't specify a value for this property or 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 job starts to run. *
** 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. * @see ManagedDataIdentifierSelector */ public String getManagedDataIdentifierSelector() { return this.managedDataIdentifierSelector; } /** *
* The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid * values are: *
** ALL (default) - 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 custom data * identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds * property. *
** RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. 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 all managed data identifiers. *
** If the job is a recurring job and you don't specify a value for this property or 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 job starts to run. *
** 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. *
* * @param managedDataIdentifierSelector * The selection type to apply when determining which managed data identifiers the job uses to analyze data. * Valid values are: ** ALL (default) - 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 custom data * identifier for the job (customDataIdentifierIds) and don't specify any values for the * managedDataIdentifierIds property. *
** RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. * 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 all managed data identifiers. *
** If the job is a recurring job and you don't specify a value for this property or 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 job starts to run. *
** 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. * @return Returns a reference to this object so that method calls can be chained together. * @see ManagedDataIdentifierSelector */ public CreateClassificationJobRequest withManagedDataIdentifierSelector(String managedDataIdentifierSelector) { setManagedDataIdentifierSelector(managedDataIdentifierSelector); return this; } /** *
* The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid * values are: *
** ALL (default) - 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 custom data * identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds * property. *
** RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. 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 all managed data identifiers. *
** If the job is a recurring job and you don't specify a value for this property or 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 job starts to run. *
** 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. *
* * @param managedDataIdentifierSelector * The selection type to apply when determining which managed data identifiers the job uses to analyze data. * Valid values are: ** ALL (default) - 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 custom data * identifier for the job (customDataIdentifierIds) and don't specify any values for the * managedDataIdentifierIds property. *
** RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. * 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 all managed data identifiers. *
** If the job is a recurring job and you don't specify a value for this property or 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 job starts to run. *
** 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. * @return Returns a reference to this object so that method calls can be chained together. * @see ManagedDataIdentifierSelector */ public CreateClassificationJobRequest withManagedDataIdentifierSelector(ManagedDataIdentifierSelector managedDataIdentifierSelector) { this.managedDataIdentifierSelector = managedDataIdentifierSelector.toString(); return this; } /** *
* A custom name for the job. The name can contain as many as 500 characters. *
* * @param name * A custom name for the job. The name can contain as many as 500 characters. */ public void setName(String name) { this.name = name; } /** ** A custom name for the job. The name can contain as many as 500 characters. *
* * @return A custom name for the job. The name can contain as many as 500 characters. */ public String getName() { return this.name; } /** ** A custom name for the job. The name can contain as many as 500 characters. *
* * @param name * A custom name for the job. The name can contain as many as 500 characters. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withName(String name) { setName(name); return this; } /** ** The S3 buckets that contain the objects to analyze, and the scope of that analysis. *
* * @param s3JobDefinition * The S3 buckets that contain the objects to analyze, and the scope of that analysis. */ public void setS3JobDefinition(S3JobDefinition s3JobDefinition) { this.s3JobDefinition = s3JobDefinition; } /** ** The S3 buckets that contain the objects to analyze, and the scope of that analysis. *
* * @return The S3 buckets that contain the objects to analyze, and the scope of that analysis. */ public S3JobDefinition getS3JobDefinition() { return this.s3JobDefinition; } /** ** The S3 buckets that contain the objects to analyze, and the scope of that analysis. *
* * @param s3JobDefinition * The S3 buckets that contain the objects to analyze, and the scope of that analysis. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withS3JobDefinition(S3JobDefinition s3JobDefinition) { setS3JobDefinition(s3JobDefinition); return this; } /** ** 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. *
* * @param 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. */ public void setSamplingPercentage(Integer samplingPercentage) { this.samplingPercentage = 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. *
* * @return 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. */ public Integer getSamplingPercentage() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withSamplingPercentage(Integer samplingPercentage) { setSamplingPercentage(samplingPercentage); return this; } /** ** 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. *
* * @param 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. */ public void setScheduleFrequency(JobScheduleFrequency scheduleFrequency) { this.scheduleFrequency = 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. *
* * @return 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. */ public JobScheduleFrequency getScheduleFrequency() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateClassificationJobRequest withScheduleFrequency(JobScheduleFrequency scheduleFrequency) { setScheduleFrequency(scheduleFrequency); return this; } /** ** 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. *
* * @return 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.
*/
public java.util.Map
* 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.
*
* 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.
*/
public void setTags(java.util.Map
* 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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateClassificationJobRequest withTags(java.util.Map