Class JobReport
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JobReport.Builder,
JobReport>
Contains the configuration parameters for a job-completion report.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
bucket()
The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.static JobReport.Builder
builder()
final Boolean
enabled()
Indicates whether the specified job will generate a job-completion report.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final JobReportFormat
format()
The format of the specified job-completion report.final String
The format of the specified job-completion report.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
prefix()
An optional prefix to describe where in the specified bucket the job-completion report will be stored.final JobReportScope
Indicates whether the job-completion report will include details of all tasks or only failed tasks.final String
Indicates whether the job-completion report will include details of all tasks or only failed tasks.static Class
<? extends JobReport.Builder> 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
bucket
The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
Directory buckets - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.
- Returns:
- The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
Directory buckets - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.
-
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 returnJobReportFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- The format of the specified job-completion report.
- See Also:
-
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 returnJobReportFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- The format of the specified job-completion report.
- See Also:
-
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
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
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 returnJobReportScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreportScopeAsString()
.- Returns:
- Indicates whether the job-completion report will include details of all tasks or only failed tasks.
- See Also:
-
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 returnJobReportScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreportScopeAsString()
.- Returns:
- Indicates whether the job-completion report will include details of all tasks or only failed tasks.
- See Also:
-
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<JobReport.Builder,
JobReport> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-