CreateClassificationJobRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.macie2.model

Class CreateClassificationJobRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.macie2.model.CreateClassificationJobRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateClassificationJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateClassificationJobRequest ()

Constructors
Constructor and Description
`CreateClassificationJobRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateClassificationJobRequest`	`addTagsEntry (String key, String value)` Add a single Tags entry
`CreateClassificationJobRequest`	`clearTagsEntries ()` Removes all the entries added into Tags.
`CreateClassificationJobRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`List<String>`	`getAllowListIds ()` An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
`String`	`getClientToken ()` A unique, case-sensitive token that you provide to ensure the idempotency of the request.
`List<String>`	`getCustomDataIdentifierIds ()` An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data.
`String`	`getDescription ()` A custom description of the job.
`Boolean`	`getInitialRun ()` For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true).
`String`	`getJobType ()` The schedule for running the job.
`List<String>`	`getManagedDataIdentifierIds ()` 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.
`String`	`getManagedDataIdentifierSelector ()` The selection type to apply when determining which managed data identifiers the job uses to analyze data.
`String`	`getName ()` A custom name for the job.
`S3JobDefinition`	`getS3JobDefinition ()` The S3 buckets that contain the objects to analyze, and the scope of that analysis.
`Integer`	`getSamplingPercentage ()` The sampling depth, as a percentage, for the job to apply when processing objects.
`JobScheduleFrequency`	`getScheduleFrequency ()` The recurrence pattern for running the job.
`Map<String,String>`	`getTags ()` A map of key-value pairs that specifies the tags to associate with the job.
`int`	`hashCode ()`
`Boolean`	`isInitialRun ()` For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true).
`void`	`setAllowListIds (Collection<String> allowListIds)` An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
`void`	`setClientToken (String clientToken)` A unique, case-sensitive token that you provide to ensure the idempotency of the request.
`void`	`setCustomDataIdentifierIds (Collection<String> customDataIdentifierIds)` An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data.
`void`	`setDescription (String description)` A custom description of the job.
`void`	`setInitialRun (Boolean initialRun)` For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true).
`void`	`setJobType (String jobType)` The schedule for running the job.
`void`	`setManagedDataIdentifierIds (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.
`void`	`setManagedDataIdentifierSelector (String managedDataIdentifierSelector)` The selection type to apply when determining which managed data identifiers the job uses to analyze data.
`void`	`setName (String name)` A custom name for the job.
`void`	`setS3JobDefinition (S3JobDefinition s3JobDefinition)` The S3 buckets that contain the objects to analyze, and the scope of that analysis.
`void`	`setSamplingPercentage (Integer samplingPercentage)` The sampling depth, as a percentage, for the job to apply when processing objects.
`void`	`setScheduleFrequency (JobScheduleFrequency scheduleFrequency)` The recurrence pattern for running the job.
`void`	`setTags (Map<String,String> tags)` A map of key-value pairs that specifies the tags to associate with the job.
`String`	`toString ()` Returns a string representation of this object.
`CreateClassificationJobRequest`	`withAllowListIds (Collection<String> allowListIds)` An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
`CreateClassificationJobRequest`	`withAllowListIds (String... allowListIds)` An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
`CreateClassificationJobRequest`	`withClientToken (String clientToken)` A unique, case-sensitive token that you provide to ensure the idempotency of the request.
`CreateClassificationJobRequest`	`withCustomDataIdentifierIds (Collection<String> customDataIdentifierIds)` An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data.
`CreateClassificationJobRequest`	`withCustomDataIdentifierIds (String... customDataIdentifierIds)` An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data.
`CreateClassificationJobRequest`	`withDescription (String description)` A custom description of the job.
`CreateClassificationJobRequest`	`withInitialRun (Boolean initialRun)` For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true).
`CreateClassificationJobRequest`	`withJobType (JobType jobType)` The schedule for running the job.
`CreateClassificationJobRequest`	`withJobType (String jobType)` The schedule for running the job.
`CreateClassificationJobRequest`	`withManagedDataIdentifierIds (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.
`CreateClassificationJobRequest`	`withManagedDataIdentifierIds (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.
`CreateClassificationJobRequest`	`withManagedDataIdentifierSelector (ManagedDataIdentifierSelector managedDataIdentifierSelector)` The selection type to apply when determining which managed data identifiers the job uses to analyze data.
`CreateClassificationJobRequest`	`withManagedDataIdentifierSelector (String managedDataIdentifierSelector)` The selection type to apply when determining which managed data identifiers the job uses to analyze data.
`CreateClassificationJobRequest`	`withName (String name)` A custom name for the job.
`CreateClassificationJobRequest`	`withS3JobDefinition (S3JobDefinition s3JobDefinition)` The S3 buckets that contain the objects to analyze, and the scope of that analysis.
`CreateClassificationJobRequest`	`withSamplingPercentage (Integer samplingPercentage)` The sampling depth, as a percentage, for the job to apply when processing objects.
`CreateClassificationJobRequest`	`withScheduleFrequency (JobScheduleFrequency scheduleFrequency)` The recurrence pattern for running the job.
`CreateClassificationJobRequest`	`withTags (Map<String,String> tags)` A map of key-value pairs that specifies the tags to associate with the job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateClassificationJobRequest
```
public CreateClassificationJobRequest()
```
- Method Detail
  - getAllowListIds
```
public List<String> getAllowListIds()
```
    An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
    
    Returns:
    
    An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
  - setAllowListIds
```
public void setAllowListIds(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.
  - withAllowListIds
```
public CreateClassificationJobRequest withAllowListIds(String... allowListIds)
```
    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 setAllowListIds(java.util.Collection) or withAllowListIds(java.util.Collection) if you want to override the existing values.
    
    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.
  - withAllowListIds
```
public CreateClassificationJobRequest withAllowListIds(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.
  - setClientToken
```
public void setClientToken(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.
  - getClientToken
```
public String getClientToken()
```
    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.
  - withClientToken
```
public CreateClassificationJobRequest withClientToken(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.
  - getCustomDataIdentifierIds
```
public List<String> getCustomDataIdentifierIds()
```
    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:
    
    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.
  - setCustomDataIdentifierIds
```
public void setCustomDataIdentifierIds(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.
  - withCustomDataIdentifierIds
```
public CreateClassificationJobRequest withCustomDataIdentifierIds(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCustomDataIdentifierIds(java.util.Collection) or withCustomDataIdentifierIds(java.util.Collection) if you want to override the existing values.
    
    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.
  - withCustomDataIdentifierIds
```
public CreateClassificationJobRequest withCustomDataIdentifierIds(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.
  - setDescription
```
public void setDescription(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.
  - getDescription
```
public String getDescription()
```
    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.
  - withDescription
```
public CreateClassificationJobRequest withDescription(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.
  - setInitialRun
```
public void setInitialRun(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.
  - getInitialRun
```
public Boolean getInitialRun()
```
    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.
  - withInitialRun
```
public CreateClassificationJobRequest withInitialRun(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.
  - isInitialRun
```
public Boolean isInitialRun()
```
    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.
  - setJobType
```
public void setJobType(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 specify 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 specify the recurrence pattern for the job.
    See Also:
    
    JobType
  - getJobType
```
public String getJobType()
```
    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.
    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:
    
    JobType
  - withJobType
```
public CreateClassificationJobRequest withJobType(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 specify 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 specify the recurrence pattern for the job.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType
  - withJobType
```
public CreateClassificationJobRequest withJobType(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.
    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 specify the recurrence pattern for the job.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType
  - getManagedDataIdentifierIds
```
public List<String> getManagedDataIdentifierIds()
```
    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:
    
    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.
  - setManagedDataIdentifierIds
```
public void setManagedDataIdentifierIds(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.
  - withManagedDataIdentifierIds
```
public CreateClassificationJobRequest withManagedDataIdentifierIds(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setManagedDataIdentifierIds(java.util.Collection) or withManagedDataIdentifierIds(java.util.Collection) if you want to override the existing values.
    
    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.
  - withManagedDataIdentifierIds
```
public CreateClassificationJobRequest withManagedDataIdentifierIds(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.
  - setManagedDataIdentifierSelector
```
public void setManagedDataIdentifierSelector(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 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.
    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 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:
    
    ManagedDataIdentifierSelector
  - getManagedDataIdentifierSelector
```
public String getManagedDataIdentifierSelector()
```
    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.
    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:
    
    ManagedDataIdentifierSelector
  - withManagedDataIdentifierSelector
```
public CreateClassificationJobRequest withManagedDataIdentifierSelector(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 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.
    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 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ManagedDataIdentifierSelector
  - withManagedDataIdentifierSelector
```
public CreateClassificationJobRequest withManagedDataIdentifierSelector(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.
    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 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ManagedDataIdentifierSelector
  - setName
```
public void setName(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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public CreateClassificationJobRequest withName(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.
  - setS3JobDefinition
```
public void setS3JobDefinition(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.
  - getS3JobDefinition
```
public S3JobDefinition getS3JobDefinition()
```
    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.
  - withS3JobDefinition
```
public CreateClassificationJobRequest withS3JobDefinition(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.
  - setSamplingPercentage
```
public void setSamplingPercentage(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.
  - getSamplingPercentage
```
public Integer getSamplingPercentage()
```
    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.
  - withSamplingPercentage
```
public CreateClassificationJobRequest withSamplingPercentage(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.
  - setScheduleFrequency
```
public void setScheduleFrequency(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.
  - getScheduleFrequency
```
public JobScheduleFrequency getScheduleFrequency()
```
    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.
  - withScheduleFrequency
```
public CreateClassificationJobRequest withScheduleFrequency(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.
  - getTags
```
public Map<String,String> getTags()
```
    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:
    
    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.
  - setTags
```
public void setTags(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.
  - withTags
```
public CreateClassificationJobRequest withTags(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.
  - addTagsEntry
```
public CreateClassificationJobRequest addTagsEntry(String key,
 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateClassificationJobRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateClassificationJobRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateClassificationJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateClassificationJobRequest

Method Detail

getAllowListIds

setAllowListIds

withAllowListIds

withAllowListIds

setClientToken

getClientToken

withClientToken

getCustomDataIdentifierIds

setCustomDataIdentifierIds

withCustomDataIdentifierIds

withCustomDataIdentifierIds

setDescription

getDescription

withDescription

setInitialRun

getInitialRun

withInitialRun

isInitialRun

setJobType

getJobType

withJobType

withJobType

getManagedDataIdentifierIds

setManagedDataIdentifierIds

withManagedDataIdentifierIds

withManagedDataIdentifierIds

setManagedDataIdentifierSelector

getManagedDataIdentifierSelector

withManagedDataIdentifierSelector

withManagedDataIdentifierSelector

setName

getName

withName

setS3JobDefinition

getS3JobDefinition

withS3JobDefinition

setSamplingPercentage

getSamplingPercentage

withSamplingPercentage

setScheduleFrequency

getScheduleFrequency

withScheduleFrequency

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone