Package software.amazon.awssdk.services.backup.model

Class ReportDeliveryChannel

java.lang.Object

software.amazon.awssdk.services.backup.model.ReportDeliveryChannel

All Implemented Interfaces:

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

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

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReportDeliveryChannel.Builder

Method Summary

Modifier and Type	Method	Description
static ReportDeliveryChannel.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	formats()	A list of the format of your reports: CSV, JSON, or both.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFormats()	For responses, this returns true if the service returned a value for the Formats property.
int	hashCode()
String	s3BucketName()	The unique name of the S3 bucket that receives your reports.
String	s3KeyPrefix()	The prefix for where Backup Audit Manager delivers your reports to Amazon S3.
List<SdkField<?>>	sdkFields()
static Class<? extends ReportDeliveryChannel.Builder>	serializableBuilderClass()
ReportDeliveryChannel.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 unique name of the S3 bucket that receives your reports.

Returns:

The unique name of the S3 bucket that receives your reports.

s3KeyPrefix

public final String s3KeyPrefix()

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

Returns:

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

hasFormats

public final boolean hasFormats()

For responses, this returns true if the service returned a value for the Formats 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.

formats

public final List<String> formats()

A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

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 hasFormats() method.

Returns:

A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

toBuilder

public ReportDeliveryChannel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReportDeliveryChannel.Builder,ReportDeliveryChannel>

builder

public static ReportDeliveryChannel.Builder builder()

serializableBuilderClass

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