Package 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("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	Description
static interface	UsageReportSubscription.Builder

Method Summary

Modifier and Type	Method	Description
static UsageReportSubscription.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubscriptionErrors()	For responses, this returns true if the service returned a value for the SubscriptionErrors property.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
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()
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

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()

For responses, this returns true if the service returned a value for the SubscriptionErrors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubscriptionErrors() method.

Returns:

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

toBuilder

public UsageReportSubscription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsageReportSubscription.Builder,UsageReportSubscription>

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo