software.amazon.awssdk.services.alexaforbusiness.model

Class BusinessReport

java.lang.Object

software.amazon.awssdk.services.alexaforbusiness.model.BusinessReport

All Implemented Interfaces:

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

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

Usage report with specified parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BusinessReport.Builder

Method Summary

Modifier and Type	Method and Description
static BusinessReport.Builder	builder()
Instant	deliveryTime() The time of report delivery.
String	downloadUrl() The download link where a user can download the report.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
BusinessReportFailureCode	failureCode() The failure code.
String	failureCodeAsString() The failure code.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
BusinessReportS3Location	s3Location() The S3 location of the output reports.
List<SdkField<?>>	sdkFields()
static Class<? extends BusinessReport.Builder>	serializableBuilderClass()
BusinessReportStatus	status() The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
String	statusAsString() The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
BusinessReport.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

status

public final BusinessReportStatus status()

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

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

Returns:

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

See Also:

BusinessReportStatus

statusAsString

public final String statusAsString()

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

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

Returns:

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

See Also:

BusinessReportStatus

failureCode

public final BusinessReportFailureCode failureCode()

The failure code.

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

Returns:

The failure code.

See Also:

BusinessReportFailureCode

failureCodeAsString

public final String failureCodeAsString()

The failure code.

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

Returns:

The failure code.

See Also:

BusinessReportFailureCode

s3Location

public final BusinessReportS3Location s3Location()

The S3 location of the output reports.

Returns:

The S3 location of the output reports.

deliveryTime

public final Instant deliveryTime()

The time of report delivery.

Returns:

The time of report delivery.

downloadUrl

public final String downloadUrl()

The download link where a user can download the report.

Returns:

The download link where a user can download the report.

toBuilder

public BusinessReport.Builder 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 interface ToCopyableBuilder<BusinessReport.Builder,BusinessReport>

Returns:

a builder for type T

builder

public static BusinessReport.Builder builder()

serializableBuilderClass

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

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.