com.amazonaws.services.quicksight.model.S3BucketConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3BucketConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
*
*/
private String bucketName;
/**
*
* The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
*
*/
private String bucketPrefix;
/**
*
* 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.
*
*/
private String bucketRegion;
/**
*
* The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
*
*
* @param bucketName
* The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
*
* The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
*
*
* @return The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
*/
public String getBucketName() {
return this.bucketName;
}
/**
*
* The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
*
*
* @param bucketName
* The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3BucketConfiguration withBucketName(String bucketName) {
setBucketName(bucketName);
return this;
}
/**
*
* The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
*
*
* @param bucketPrefix
* The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
*/
public void setBucketPrefix(String bucketPrefix) {
this.bucketPrefix = bucketPrefix;
}
/**
*
* The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
*
*
* @return The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
*/
public String getBucketPrefix() {
return this.bucketPrefix;
}
/**
*
* The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
*
*
* @param bucketPrefix
* The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3BucketConfiguration withBucketPrefix(String bucketPrefix) {
setBucketPrefix(bucketPrefix);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setBucketRegion(String bucketRegion) {
this.bucketRegion = 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.
*
*
* @return 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.
*/
public String getBucketRegion() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3BucketConfiguration withBucketRegion(String bucketRegion) {
setBucketRegion(bucketRegion);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getBucketName() != null)
sb.append("BucketName: ").append(getBucketName()).append(",");
if (getBucketPrefix() != null)
sb.append("BucketPrefix: ").append(getBucketPrefix()).append(",");
if (getBucketRegion() != null)
sb.append("BucketRegion: ").append(getBucketRegion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3BucketConfiguration == false)
return false;
S3BucketConfiguration other = (S3BucketConfiguration) obj;
if (other.getBucketName() == null ^ this.getBucketName() == null)
return false;
if (other.getBucketName() != null && other.getBucketName().equals(this.getBucketName()) == false)
return false;
if (other.getBucketPrefix() == null ^ this.getBucketPrefix() == null)
return false;
if (other.getBucketPrefix() != null && other.getBucketPrefix().equals(this.getBucketPrefix()) == false)
return false;
if (other.getBucketRegion() == null ^ this.getBucketRegion() == null)
return false;
if (other.getBucketRegion() != null && other.getBucketRegion().equals(this.getBucketRegion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBucketName() == null) ? 0 : getBucketName().hashCode());
hashCode = prime * hashCode + ((getBucketPrefix() == null) ? 0 : getBucketPrefix().hashCode());
hashCode = prime * hashCode + ((getBucketRegion() == null) ? 0 : getBucketRegion().hashCode());
return hashCode;
}
@Override
public S3BucketConfiguration clone() {
try {
return (S3BucketConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.quicksight.model.transform.S3BucketConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}