software.amazon.awssdk.services.s3control.model

Class JobListDescriptor

java.lang.Object

software.amazon.awssdk.services.s3control.model.JobListDescriptor

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobListDescriptor.Builder,JobListDescriptor>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobListDescriptor
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobListDescriptor.Builder,JobListDescriptor>

Contains the configuration and status information for a single job retrieved as part of a job list.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobListDescriptor.Builder

Method Summary

Modifier and Type	Method and Description
static JobListDescriptor.Builder	builder()
Instant	creationTime() A timestamp indicating when the specified job was created.
String	description() The user-specified description that was included in the specified job's Create Job request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId() The ID for the specified job.
OperationName	operation() The operation that the specified job is configured to run on every object listed in the manifest.
String	operationAsString() The operation that the specified job is configured to run on every object listed in the manifest.
Integer	priority() The current priority for the specified job.
JobProgressSummary	progressSummary() Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
List<SdkField<?>>	sdkFields()
static Class<? extends JobListDescriptor.Builder>	serializableBuilderClass()
JobStatus	status() The specified job's current status.
String	statusAsString() The specified job's current status.
Instant	terminationDate() A timestamp indicating when the specified job terminated.
JobListDescriptor.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

jobId

public final String jobId()

The ID for the specified job.

Returns:

The ID for the specified job.

description

public final String description()

The user-specified description that was included in the specified job's Create Job request.

Returns:

The user-specified description that was included in the specified job's Create Job request.

operation

public final OperationName operation()

The operation that the specified job is configured to run on every object listed in the manifest.

If the service returns an enum value that is not available in the current SDK version, operation will return OperationName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

Returns:

The operation that the specified job is configured to run on every object listed in the manifest.

See Also:

OperationName

operationAsString

public final String operationAsString()

The operation that the specified job is configured to run on every object listed in the manifest.

If the service returns an enum value that is not available in the current SDK version, operation will return OperationName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

Returns:

The operation that the specified job is configured to run on every object listed in the manifest.

See Also:

OperationName

priority

public final Integer priority()

The current priority for the specified job.

Returns:

The current priority for the specified job.

status

public final JobStatus status()

The specified job's current status.

If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The specified job's current status.

See Also:

JobStatus

statusAsString

public final String statusAsString()

The specified job's current status.

If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The specified job's current status.

See Also:

JobStatus

creationTime

public final Instant creationTime()

A timestamp indicating when the specified job was created.

Returns:

A timestamp indicating when the specified job was created.

terminationDate

public final Instant terminationDate()

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

Returns:

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

progressSummary

public final JobProgressSummary progressSummary()

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

Returns:

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

toBuilder

public JobListDescriptor.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobListDescriptor.Builder,JobListDescriptor>

builder

public static JobListDescriptor.Builder builder()

serializableBuilderClass

public static Class<? extends JobListDescriptor.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo