com.amazonaws.services.quicksight.model

Class S3BucketConfiguration

java.lang.Object

com.amazonaws.services.quicksight.model.S3BucketConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3BucketConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
S3BucketConfiguration()

Method Summary

Modifier and Type	Method and Description
S3BucketConfiguration	clone()
boolean	equals(Object obj)
String	getBucketName() The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
String	getBucketPrefix() The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
String	getBucketRegion() The region that the Amazon S3 bucket is located in.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBucketName(String bucketName) The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
void	setBucketPrefix(String bucketPrefix) The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
void	setBucketRegion(String bucketRegion) The region that the Amazon S3 bucket is located in.
String	toString() Returns a string representation of this object.
S3BucketConfiguration	withBucketName(String bucketName) The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
S3BucketConfiguration	withBucketPrefix(String bucketPrefix) The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
S3BucketConfiguration	withBucketRegion(String bucketRegion) The region that the Amazon S3 bucket is located in.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

S3BucketConfiguration

public S3BucketConfiguration()

Method Detail

setBucketName

public void setBucketName(String bucketName)

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

Parameters:

bucketName - The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

getBucketName

public String getBucketName()

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

Returns:

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

withBucketName

public S3BucketConfiguration withBucketName(String bucketName)

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

Parameters:

bucketName - The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBucketPrefix

public void setBucketPrefix(String bucketPrefix)

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

Parameters:

bucketPrefix - The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

getBucketPrefix

public String getBucketPrefix()

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

Returns:

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

withBucketPrefix

public S3BucketConfiguration withBucketPrefix(String bucketPrefix)

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

Parameters:

bucketPrefix - The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBucketRegion

public void setBucketRegion(String bucketRegion)

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

Parameters:

bucketRegion - The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

getBucketRegion

public String getBucketRegion()

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

Returns:

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

withBucketRegion

public S3BucketConfiguration withBucketRegion(String bucketRegion)

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

Parameters:

bucketRegion - The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public S3BucketConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.