DescribeClassificationJobResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.macie2.model.Macie2Response
    - - software.amazon.awssdk.services.macie2.model.DescribeClassificationJobResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeClassificationJobResponse.Builder,DescribeClassificationJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeClassificationJobResponse
extends Macie2Response
implements ToCopyableBuilder<DescribeClassificationJobResponse.Builder,DescribeClassificationJobResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeClassificationJobResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeClassificationJobResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeClassificationJobResponse.Builder`	`builder()`
`String`	`clientToken()` The token that was provided to ensure the idempotency of the request to create the job.
`Instant`	`createdAt()` The date and time, in UTC and extended ISO 8601 format, when the job was created.
`List<String>`	`customDataIdentifierIds()` The custom data identifiers that the job uses to analyze data.
`String`	`description()` The custom description of the job.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCustomDataIdentifierIds()` Returns true if the CustomDataIdentifierIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Boolean`	`initialRun()` Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.
`String`	`jobArn()` The Amazon Resource Name (ARN) of the job.
`String`	`jobId()` The unique identifier for the job.
`JobStatus`	`jobStatus()` The current status of the job.
`String`	`jobStatusAsString()` The current status of the job.
`JobType`	`jobType()` The schedule for running the job.
`String`	`jobTypeAsString()` The schedule for running the job.
`LastRunErrorStatus`	`lastRunErrorStatus()` Specifies whether any account- or bucket-level access errors occurred when the job ran.
`Instant`	`lastRunTime()` The date and time, in UTC and extended ISO 8601 format, when the job started.
`String`	`name()` The custom name of the job.
`S3JobDefinition`	`s3JobDefinition()` The S3 buckets that the job is configured to analyze, and the scope of that analysis.
`Integer`	`samplingPercentage()` The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
`JobScheduleFrequency`	`scheduleFrequency()` The recurrence pattern for running the job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeClassificationJobResponse.Builder>`	`serializableBuilderClass()`
`Statistics`	`statistics()` The number of times that the job has run and processing statistics for the job's current run.
`Map<String,String>`	`tags()` A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.
`DescribeClassificationJobResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`UserPausedDetails`	`userPausedDetails()` If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job 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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientToken
```
public String 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
```
public Instant 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 boolean hasCustomDataIdentifierIds()
```
    Returns true if the CustomDataIdentifierIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - customDataIdentifierIds
```
public List<String> customDataIdentifierIds()
```
    The custom data identifiers that the job uses to analyze data.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCustomDataIdentifierIds() to see if a value was sent in this field.
    
    Returns:
    
    The custom data identifiers that the job uses to analyze data.
  - description
```
public String description()
```
    The custom description of the job.
    
    Returns:
    
    The custom description of the job.
  - initialRun
```
public Boolean initialRun()
```
    Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.
    
    Returns:
    
    Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.
  - jobArn
```
public String jobArn()
```
    The Amazon Resource Name (ARN) of the job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the job.
  - jobId
```
public String jobId()
```
    The unique identifier for the job.
    
    Returns:
    
    The unique identifier for the job.
  - jobStatus
```
public JobStatus jobStatus()
```
    The current status of the job. Possible values are:
    - CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.
    - 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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's 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 return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().
    Returns:
    The current status of the job. Possible values are:
    
    CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.
    
    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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's expiration date, refer to the UserPausedDetails.jobExpiresAt property.
    See Also:
    
    JobStatus
  - jobStatusAsString
```
public String jobStatusAsString()
```
    The current status of the job. Possible values are:
    - CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.
    - 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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's 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 return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().
    Returns:
    The current status of the job. Possible values are:
    
    CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.
    
    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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's expiration date, refer to the UserPausedDetails.jobExpiresAt property.
    See Also:
    
    JobStatus
  - jobType
```
public JobType 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 return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().
    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:
    
    JobType
  - jobTypeAsString
```
public String 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 return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().
    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:
    
    JobType
  - lastRunErrorStatus
```
public LastRunErrorStatus 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
```
public Instant 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.
    
    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.
  - name
```
public String name()
```
    The custom name of the job.
    
    Returns:
    
    The custom name of the job.
  - s3JobDefinition
```
public S3JobDefinition s3JobDefinition()
```
    The S3 buckets that the job is configured to analyze, and the scope of that analysis.
    
    Returns:
    
    The S3 buckets that the job is configured to analyze, and the scope of that analysis.
  - samplingPercentage
```
public Integer 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
```
public JobScheduleFrequency scheduleFrequency()
```
    The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
    
    Returns:
    
    The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
  - statistics
```
public Statistics 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 boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public Map<String,String> 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.
  - userPausedDetails
```
public UserPausedDetails userPausedDetails()
```
    If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job 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 will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
  - toBuilder
```
public DescribeClassificationJobResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeClassificationJobResponse.Builder,DescribeClassificationJobResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeClassificationJobResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeClassificationJobResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeClassificationJobResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.macie2.model.Macie2Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientToken

createdAt

hasCustomDataIdentifierIds

customDataIdentifierIds

description

initialRun

jobArn

jobId

jobStatus

jobStatusAsString

jobType

jobTypeAsString

lastRunErrorStatus

lastRunTime

name

s3JobDefinition

samplingPercentage

scheduleFrequency

statistics

hasTags

tags

userPausedDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields