software.amazon.awssdk.services.appstream.model

Class UsageReportSubscription

java.lang.Object

software.amazon.awssdk.services.appstream.model.UsageReportSubscription

All Implemented Interfaces:

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

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

Describes information about the usage report subscription.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UsageReportSubscription.Builder

Method Summary

Modifier and Type	Method and Description
static UsageReportSubscription.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubscriptionErrors() Returns true if the SubscriptionErrors property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Instant	lastGeneratedReportDate() The time when the last usage report was generated.
String	s3BucketName() The Amazon S3 bucket where generated reports are stored.
UsageReportSchedule	schedule() The schedule for generating usage reports.
String	scheduleAsString() The schedule for generating usage reports.
List<SdkField<?>>	sdkFields()
static Class<? extends UsageReportSubscription.Builder>	serializableBuilderClass()
List<LastReportGenerationExecutionError>	subscriptionErrors() The errors that were returned if usage reports couldn't be generated.
UsageReportSubscription.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

s3BucketName

public final String s3BucketName()

The Amazon S3 bucket where generated reports are stored.

If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

Returns:

The Amazon S3 bucket where generated reports are stored.

If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

schedule

public final UsageReportSchedule schedule()

The schedule for generating usage reports.

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

Returns:

The schedule for generating usage reports.

See Also:

UsageReportSchedule

scheduleAsString

public final String scheduleAsString()

The schedule for generating usage reports.

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

Returns:

The schedule for generating usage reports.

See Also:

UsageReportSchedule

lastGeneratedReportDate

public final Instant lastGeneratedReportDate()

The time when the last usage report was generated.

Returns:

The time when the last usage report was generated.

hasSubscriptionErrors

public final boolean hasSubscriptionErrors()

Returns true if the SubscriptionErrors property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

subscriptionErrors

public final List<LastReportGenerationExecutionError> subscriptionErrors()

The errors that were returned if usage reports couldn't be generated.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSubscriptionErrors() to see if a value was sent in this field.

Returns:

The errors that were returned if usage reports couldn't be generated.

toBuilder

public UsageReportSubscription.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<UsageReportSubscription.Builder,UsageReportSubscription>

Returns:

a builder for type T

builder

public static UsageReportSubscription.Builder builder()

serializableBuilderClass

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