Package software.amazon.awssdk.services.s3control.model

Class JobReport

java.lang.Object

software.amazon.awssdk.services.s3control.model.JobReport

All Implemented Interfaces:

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

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

Contains the configuration parameters for a job-completion report.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobReport.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
static JobReport.Builder	builder()
Boolean	enabled()	Indicates whether the specified job will generate a job-completion report.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
JobReportFormat	format()	The format of the specified job-completion report.
String	formatAsString()	The format of the specified job-completion report.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	prefix()	An optional prefix to describe where in the specified bucket the job-completion report will be stored.
JobReportScope	reportScope()	Indicates whether the job-completion report will include details of all tasks or only failed tasks.
String	reportScopeAsString()	Indicates whether the job-completion report will include details of all tasks or only failed tasks.
List<SdkField<?>>	sdkFields()
static Class<? extends JobReport.Builder>	serializableBuilderClass()
JobReport.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

bucket

public final String bucket()

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Returns:

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

format

public final JobReportFormat format()

The format of the specified job-completion report.

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

Returns:

The format of the specified job-completion report.

See Also:

JobReportFormat

formatAsString

public final String formatAsString()

The format of the specified job-completion report.

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

Returns:

The format of the specified job-completion report.

See Also:

JobReportFormat

enabled

public final Boolean enabled()

Indicates whether the specified job will generate a job-completion report.

Returns:

Indicates whether the specified job will generate a job-completion report.

prefix

public final String prefix()

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Returns:

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

reportScope

public final JobReportScope reportScope()

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

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

Returns:

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

See Also:

JobReportScope

reportScopeAsString

public final String reportScopeAsString()

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

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

Returns:

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

See Also:

JobReportScope

toBuilder

public JobReport.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobReport.Builder,JobReport>

builder

public static JobReport.Builder builder()

serializableBuilderClass

public static Class<? extends JobReport.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