Class ReportJob
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReportJob.Builder,
ReportJob>
Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReportJob.Builder
builder()
final Instant
The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC).final Instant
The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC).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) final int
hashCode()
final ReportDestination
The S3 bucket name and S3 keys for the destination where the report job publishes the report.final String
The identifier for a report job.final String
An Amazon Resource Name (ARN) that uniquely identifies a resource.final String
Identifies the report template for the report.static Class
<? extends ReportJob.Builder> final String
status()
The status of a report job.final String
A message explaining the status of the report 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
reportJobId
The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.
- Returns:
- The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.
-
reportPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- Returns:
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
-
reportTemplate
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
- Returns:
- Identifies the report template for the report. Reports are built using a report template. The report
templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
-
creationTime
The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The
value of
CreationTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
-
completionTime
The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of
CompletionTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC).
The value of
CompletionTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
-
status
The status of a report job. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
COMPLETED
means that the report is available for your review at your designated destination. If the status isFAILED
, review theStatusMessage
for the reason.- Returns:
- The status of a report job. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
COMPLETED
means that the report is available for your review at your designated destination. If the status isFAILED
, review theStatusMessage
for the reason.
-
statusMessage
A message explaining the status of the report job.
- Returns:
- A message explaining the status of the report job.
-
reportDestination
The S3 bucket name and S3 keys for the destination where the report job publishes the report.
- Returns:
- The S3 bucket name and S3 keys for the destination where the report job publishes the report.
-
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<ReportJob.Builder,
ReportJob> - 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
-