Class DescribeClassificationJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeClassificationJobResponse.Builder,
DescribeClassificationJobResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionAn array of unique identifiers, one for each allow list that the job uses when it analyzes data.builder()
final String
The token that was provided to ensure the idempotency of the request to create the job.final Instant
The date and time, in UTC and extended ISO 8601 format, when the job was created.An array of unique identifiers, one for each custom data identifier that the job uses when it analyzes data.final String
The custom description of the job.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the AllowListIds property.final boolean
For responses, this returns true if the service returned a value for the CustomDataIdentifierIds property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ManagedDataIdentifierIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true).final String
jobArn()
The Amazon Resource Name (ARN) of the job.final String
jobId()
The unique identifier for the job.final JobStatus
The current status of the job.final String
The current status of the job.final JobType
jobType()
The schedule for running the job.final String
The schedule for running the job.final LastRunErrorStatus
Specifies whether any account- or bucket-level access errors occurred when the job ran.final Instant
The date and time, in UTC and extended ISO 8601 format, when the job started.An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data.The selection type that determines which managed data identifiers the job uses when it analyzes data.final String
The selection type that determines which managed data identifiers the job uses when it analyzes data.final String
name()
The custom name of the job.final S3JobDefinition
The S3 buckets that contain the objects to analyze, and the scope of that analysis.final Integer
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.final JobScheduleFrequency
The recurrence pattern for running the job.static Class
<? extends DescribeClassificationJobResponse.Builder> final Statistics
The number of times that the job has run and processing statistics for the job's current run.tags()
A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final UserPausedDetails
If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed.Methods inherited from class software.amazon.awssdk.services.macie2.model.Macie2Response
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasAllowListIds
public final boolean hasAllowListIds()For responses, this returns true if the service returned a value for the AllowListIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
allowListIds
An array of unique identifiers, one for each allow list that the job uses when it analyzes data.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAllowListIds()
method.- Returns:
- An array of unique identifiers, one for each allow list that the job uses when it analyzes data.
-
clientToken
The token that was provided to ensure the idempotency of the request to create the job.
- Returns:
- The token that was provided to ensure the idempotency of the request to create the job.
-
createdAt
The date and time, in UTC and extended ISO 8601 format, when the job was created.
- Returns:
- The date and time, in UTC and extended ISO 8601 format, when the job was created.
-
hasCustomDataIdentifierIds
public final boolean hasCustomDataIdentifierIds()For responses, this returns true if the service returned a value for the CustomDataIdentifierIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
customDataIdentifierIds
An array of unique identifiers, one for each custom data identifier that the job uses when it analyzes data. This value is null if the job uses only managed data identifiers to analyze data.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCustomDataIdentifierIds()
method.- Returns:
- An array of unique identifiers, one for each custom data identifier that the job uses when it analyzes data. This value is null if the job uses only managed data identifiers to analyze data.
-
description
The custom description of the job.
- Returns:
- The custom description of the job.
-
initialRun
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.
- Returns:
- For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.
-
jobArn
The Amazon Resource Name (ARN) of the job.
- Returns:
- The Amazon Resource Name (ARN) of the job.
-
jobId
The unique identifier for the job.
- Returns:
- The unique identifier for the job.
-
jobStatus
The current status of the job. Possible values are:
-
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
-
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
-
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
-
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
-
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
-
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the job. Possible values are:
-
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
-
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
-
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
-
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
-
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
-
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
-
- See Also:
-
-
jobStatusAsString
The current status of the job. Possible values are:
-
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
-
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
-
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
-
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
-
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
-
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the job. Possible values are:
-
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
-
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
-
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
-
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
-
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
-
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
-
- See Also:
-
-
jobType
The schedule for running the job. Possible values are:
-
ONE_TIME - The job runs only once.
-
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
If the service returns an enum value that is not available in the current SDK version,
jobType
will returnJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- The schedule for running the job. Possible values are:
-
ONE_TIME - The job runs only once.
-
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
-
- See Also:
-
-
jobTypeAsString
The schedule for running the job. Possible values are:
-
ONE_TIME - The job runs only once.
-
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
If the service returns an enum value that is not available in the current SDK version,
jobType
will returnJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- The schedule for running the job. Possible values are:
-
ONE_TIME - The job runs only once.
-
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
-
- See Also:
-
-
lastRunErrorStatus
Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.
- Returns:
- Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.
-
lastRunTime
The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was created.
- Returns:
- The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was created.
-
hasManagedDataIdentifierIds
public final boolean hasManagedDataIdentifierIds()For responses, this returns true if the service returned a value for the ManagedDataIdentifierIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
managedDataIdentifierIds
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasManagedDataIdentifierIds()
method.- Returns:
- An array of unique identifiers, one for each managed data identifier that the job is explicitly
configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on
the managed data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
-
managedDataIdentifierSelector
The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:
-
ALL - Use all managed data identifiers.
-
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. Use only custom data identifiers (customDataIdentifierIds).
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.
If the service returns an enum value that is not available in the current SDK version,
managedDataIdentifierSelector
will returnManagedDataIdentifierSelector.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedDataIdentifierSelectorAsString()
.- Returns:
- The selection type that determines which managed data identifiers the job uses when it analyzes data.
Possible values are:
-
ALL - Use all managed data identifiers.
-
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. Use only custom data identifiers (customDataIdentifierIds).
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.
-
- See Also:
-
-
managedDataIdentifierSelectorAsString
The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:
-
ALL - Use all managed data identifiers.
-
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. Use only custom data identifiers (customDataIdentifierIds).
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.
If the service returns an enum value that is not available in the current SDK version,
managedDataIdentifierSelector
will returnManagedDataIdentifierSelector.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedDataIdentifierSelectorAsString()
.- Returns:
- The selection type that determines which managed data identifiers the job uses when it analyzes data.
Possible values are:
-
ALL - Use all managed data identifiers.
-
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. Use only custom data identifiers (customDataIdentifierIds).
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.
-
- See Also:
-
-
name
The custom name of the job.
- Returns:
- The custom name of the job.
-
s3JobDefinition
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.
-
samplingPercentage
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
- Returns:
- The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
-
scheduleFrequency
The recurrence pattern for running the job. This value is null if the job is configured to run only once.
- Returns:
- The recurrence pattern for running the job. This value is null if the job is configured to run only once.
-
statistics
The number of times that the job has run and processing statistics for the job's current run.
- Returns:
- The number of times that the job has run and processing statistics for the job's current run.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.
-
userPausedDetails
If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
- Returns:
- If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeClassificationJobResponse.Builder,
DescribeClassificationJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-