ClassificationJobArgs class

The set of arguments for ClassificationJob. The set of arguments for ClassificationJob.

Constructors

ClassificationJobArgs({Input<List<String>?>? customDataIdentifierIds, Input<String?>? description, Input<bool?>? initialRun, Input<String?>? jobStatus, required Input<String> jobType, Input<String?>? name, Input<String?>? namePrefix, Input<String?>? region, required Input<ClassificationJobS3JobDefinition> s3JobDefinition, Input<int?>? samplingPercentage, Input<ClassificationJobScheduleFrequency?>? scheduleFrequency, Input<Map<String, String>?>? tags})
Creates a new ClassificationJobArgs. customDataIdentifierIds The custom data identifiers to use for data analysis and classification. description A custom description of the job. The description can contain as many as 200 characters. initialRun Specifies whether to analyze all existing, eligible objects immediately after the job is created. jobStatus The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED 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. name A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix. namePrefix Creates a unique name beginning with the specified prefix. Conflicts with name. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. s3JobDefinition The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below) 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. 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. (documented below) tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
const
ClassificationJobArgs.fromMap(Map<String, dynamic> map)
factory

Properties

customDataIdentifierIds → Input<List<String>?>?
The custom data identifiers to use for data analysis and classification.
final
description → Input<String?>?
A custom description of the job. The description can contain as many as 200 characters.
final
hashCode → int
The hash code for this object.
no setterinherited
initialRun → Input<bool?>?
Specifies whether to analyze all existing, eligible objects immediately after the job is created.
final
jobStatus → Input<String?>?
The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED
final
jobType → Input<String>
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.
final
name → Input<String?>?
A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix.
final
namePrefix → Input<String?>?
Creates a unique name beginning with the specified prefix. Conflicts with name.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
s3JobDefinition → Input<ClassificationJobS3JobDefinition>
The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
final
samplingPercentage → Input<int?>?
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.
final
scheduleFrequency → Input<ClassificationJobScheduleFrequency?>?
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. (documented below)
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited