CreateClassificationJobRequest (AWS SDK for Java

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 Instance Methods Concrete 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)`
`String`	`getClientToken()` A unique, case-sensitive token that you provide to ensure the idempotency of the request.
`List<String>`	`getCustomDataIdentifierIds()` The custom data identifiers to use for data analysis and classification.
`String`	`getDescription()` A custom description of the job.
`Boolean`	`getInitialRun()` Specifies whether to analyze all existing, eligible objects immediately after the job is created.
`String`	`getJobType()` The schedule for running the job.
`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, 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()` Specifies whether to analyze all existing, eligible objects immediately after the job is created.
`void`	`setClientToken(String clientToken)` A unique, case-sensitive token that you provide to ensure the idempotency of the request.
`void`	`setCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)` The custom data identifiers to use for data analysis and classification.
`void`	`setDescription(String description)` A custom description of the job.
`void`	`setInitialRun(Boolean initialRun)` Specifies whether to analyze all existing, eligible objects immediately after the job is created.
`void`	`setJobType(String jobType)` The schedule for running the job.
`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, 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`	`withClientToken(String clientToken)` A unique, case-sensitive token that you provide to ensure the idempotency of the request.
`CreateClassificationJobRequest`	`withCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)` The custom data identifiers to use for data analysis and classification.
`CreateClassificationJobRequest`	`withCustomDataIdentifierIds(String... customDataIdentifierIds)` The custom data identifiers to use for data analysis and classification.
`CreateClassificationJobRequest`	`withDescription(String description)` A custom description of the job.
`CreateClassificationJobRequest`	`withInitialRun(Boolean initialRun)` Specifies whether to analyze all existing, eligible objects immediately after the job is created.
`CreateClassificationJobRequest`	`withJobType(JobType jobType)` The schedule for running the job.
`CreateClassificationJobRequest`	`withJobType(String jobType)` The schedule for running the job.
`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, 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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateClassificationJobRequest
```
public CreateClassificationJobRequest()
```
- Method Detail
  - 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()
```
    The custom data identifiers to use for data analysis and classification.
    
    Returns:
    
    The custom data identifiers to use for data analysis and classification.
  - setCustomDataIdentifierIds
```
public void setCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)
```
    The custom data identifiers to use for data analysis and classification.
    
    Parameters:
    
    customDataIdentifierIds - The custom data identifiers to use for data analysis and classification.
  - withCustomDataIdentifierIds
```
public CreateClassificationJobRequest withCustomDataIdentifierIds(String... customDataIdentifierIds)
```
    The custom data identifiers to use for data analysis and classification.
    
    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 - The custom data identifiers to use for data analysis and classification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCustomDataIdentifierIds
```
public CreateClassificationJobRequest withCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)
```
    The custom data identifiers to use for data analysis and classification.
    
    Parameters:
    
    customDataIdentifierIds - The custom data identifiers to use for data analysis and classification.
    
    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)
```
    Specifies whether to analyze all existing, eligible objects immediately after the job is created.
    
    Parameters:
    
    initialRun - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
  - getInitialRun
```
public Boolean getInitialRun()
```
    Specifies whether to analyze all existing, eligible objects immediately after the job is created.
    
    Returns:
    
    Specifies whether to analyze all existing, eligible objects immediately after the job is created.
  - withInitialRun
```
public CreateClassificationJobRequest withInitialRun(Boolean initialRun)
```
    Specifies whether to analyze all existing, eligible objects immediately after the job is created.
    
    Parameters:
    
    initialRun - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isInitialRun
```
public Boolean isInitialRun()
```
    Specifies whether to analyze all existing, eligible objects immediately after the job is created.
    
    Returns:
    
    Specifies whether to analyze all existing, eligible objects immediately after the job is created.
  - 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 define the recurrence pattern for the job.
    Parameters:
    jobType - The schedule for running the job. Valid values are:
    
    ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
    
    SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
    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 define 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 define 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 define the recurrence pattern for the job.
    Parameters:
    jobType - The schedule for running the job. Valid values are:
    
    ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
    
    SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType
  - 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 define the recurrence pattern for the job.
    Parameters:
    jobType - The schedule for running the job. Valid values are:
    
    ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
    
    SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType
  - 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, 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, 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, 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, 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, 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, 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()

Did this page help you?

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

setClientToken

getClientToken

withClientToken

getCustomDataIdentifierIds

setCustomDataIdentifierIds

withCustomDataIdentifierIds

withCustomDataIdentifierIds

setDescription

getDescription

withDescription

setInitialRun

getInitialRun

withInitialRun

isInitialRun

setJobType

getJobType

withJobType

withJobType

setName

getName

withName

setS3JobDefinition

getS3JobDefinition

withS3JobDefinition

setSamplingPercentage

getSamplingPercentage

withSamplingPercentage

setScheduleFrequency

getScheduleFrequency

withScheduleFrequency

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone