com.amazonaws.services.quicksight.model.AccountSettings Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* Copyright 2018-2023 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;
/**
*
* The Amazon QuickSight settings associated with your Amazon Web Services account.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AccountSettings implements Serializable, Cloneable, StructuredPojo {
/**
*
* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You
* create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it
* appears only when users sign in.
*
*/
private String accountName;
/**
*
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
*
*/
private String edition;
/**
*
* The default Amazon QuickSight namespace for your Amazon Web Services account.
*
*/
private String defaultNamespace;
/**
*
* The main notification email for your Amazon QuickSight subscription.
*
*/
private String notificationEmail;
/**
*
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more
* information about turning on public sharing, see UpdatePublicSharingSettings.
*
*/
private Boolean publicSharingEnabled;
/**
*
* A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
* value doesn't allow the account to be deleted and results in an error message if a user tries to make a
* DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.
*
*/
private Boolean terminationProtectionEnabled;
/**
*
* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You
* create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it
* appears only when users sign in.
*
*
* @param accountName
* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services
* account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web
* Services and it appears only when users sign in.
*/
public void setAccountName(String accountName) {
this.accountName = accountName;
}
/**
*
* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You
* create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it
* appears only when users sign in.
*
*
* @return The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services
* account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web
* Services and it appears only when users sign in.
*/
public String getAccountName() {
return this.accountName;
}
/**
*
* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You
* create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it
* appears only when users sign in.
*
*
* @param accountName
* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services
* account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web
* Services and it appears only when users sign in.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccountSettings withAccountName(String accountName) {
setAccountName(accountName);
return this;
}
/**
*
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
*
*
* @param edition
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard
* edition.
* @see Edition
*/
public void setEdition(String edition) {
this.edition = edition;
}
/**
*
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
*
*
* @return The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard
* edition.
* @see Edition
*/
public String getEdition() {
return this.edition;
}
/**
*
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
*
*
* @param edition
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard
* edition.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Edition
*/
public AccountSettings withEdition(String edition) {
setEdition(edition);
return this;
}
/**
*
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
*
*
* @param edition
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard
* edition.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Edition
*/
public AccountSettings withEdition(Edition edition) {
this.edition = edition.toString();
return this;
}
/**
*
* The default Amazon QuickSight namespace for your Amazon Web Services account.
*
*
* @param defaultNamespace
* The default Amazon QuickSight namespace for your Amazon Web Services account.
*/
public void setDefaultNamespace(String defaultNamespace) {
this.defaultNamespace = defaultNamespace;
}
/**
*
* The default Amazon QuickSight namespace for your Amazon Web Services account.
*
*
* @return The default Amazon QuickSight namespace for your Amazon Web Services account.
*/
public String getDefaultNamespace() {
return this.defaultNamespace;
}
/**
*
* The default Amazon QuickSight namespace for your Amazon Web Services account.
*
*
* @param defaultNamespace
* The default Amazon QuickSight namespace for your Amazon Web Services account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccountSettings withDefaultNamespace(String defaultNamespace) {
setDefaultNamespace(defaultNamespace);
return this;
}
/**
*
* The main notification email for your Amazon QuickSight subscription.
*
*
* @param notificationEmail
* The main notification email for your Amazon QuickSight subscription.
*/
public void setNotificationEmail(String notificationEmail) {
this.notificationEmail = notificationEmail;
}
/**
*
* The main notification email for your Amazon QuickSight subscription.
*
*
* @return The main notification email for your Amazon QuickSight subscription.
*/
public String getNotificationEmail() {
return this.notificationEmail;
}
/**
*
* The main notification email for your Amazon QuickSight subscription.
*
*
* @param notificationEmail
* The main notification email for your Amazon QuickSight subscription.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccountSettings withNotificationEmail(String notificationEmail) {
setNotificationEmail(notificationEmail);
return this;
}
/**
*
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more
* information about turning on public sharing, see UpdatePublicSharingSettings.
*
*
* @param publicSharingEnabled
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For
* more information about turning on public sharing, see UpdatePublicSharingSettings.
*/
public void setPublicSharingEnabled(Boolean publicSharingEnabled) {
this.publicSharingEnabled = publicSharingEnabled;
}
/**
*
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more
* information about turning on public sharing, see UpdatePublicSharingSettings.
*
*
* @return A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For
* more information about turning on public sharing, see UpdatePublicSharingSettings.
*/
public Boolean getPublicSharingEnabled() {
return this.publicSharingEnabled;
}
/**
*
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more
* information about turning on public sharing, see UpdatePublicSharingSettings.
*
*
* @param publicSharingEnabled
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For
* more information about turning on public sharing, see UpdatePublicSharingSettings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccountSettings withPublicSharingEnabled(Boolean publicSharingEnabled) {
setPublicSharingEnabled(publicSharingEnabled);
return this;
}
/**
*
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more
* information about turning on public sharing, see UpdatePublicSharingSettings.
*
*
* @return A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For
* more information about turning on public sharing, see UpdatePublicSharingSettings.
*/
public Boolean isPublicSharingEnabled() {
return this.publicSharingEnabled;
}
/**
*
* A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
* value doesn't allow the account to be deleted and results in an error message if a user tries to make a
* DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.
*
*
* @param terminationProtectionEnabled
* A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A
* True value doesn't allow the account to be deleted and results in an error message if a user
* tries to make a DeleteAccountSubsctiption request. A False value will allow the
* ccount to be deleted.
*/
public void setTerminationProtectionEnabled(Boolean terminationProtectionEnabled) {
this.terminationProtectionEnabled = terminationProtectionEnabled;
}
/**
*
* A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
* value doesn't allow the account to be deleted and results in an error message if a user tries to make a
* DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.
*
*
* @return A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A
* True value doesn't allow the account to be deleted and results in an error message if a user
* tries to make a DeleteAccountSubsctiption request. A False value will allow the
* ccount to be deleted.
*/
public Boolean getTerminationProtectionEnabled() {
return this.terminationProtectionEnabled;
}
/**
*
* A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
* value doesn't allow the account to be deleted and results in an error message if a user tries to make a
* DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.
*
*
* @param terminationProtectionEnabled
* A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A
* True value doesn't allow the account to be deleted and results in an error message if a user
* tries to make a DeleteAccountSubsctiption request. A False value will allow the
* ccount to be deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccountSettings withTerminationProtectionEnabled(Boolean terminationProtectionEnabled) {
setTerminationProtectionEnabled(terminationProtectionEnabled);
return this;
}
/**
*
* A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
* value doesn't allow the account to be deleted and results in an error message if a user tries to make a
* DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.
*
*
* @return A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A
* True value doesn't allow the account to be deleted and results in an error message if a user
* tries to make a DeleteAccountSubsctiption request. A False value will allow the
* ccount to be deleted.
*/
public Boolean isTerminationProtectionEnabled() {
return this.terminationProtectionEnabled;
}
/**
* 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 (getAccountName() != null)
sb.append("AccountName: ").append(getAccountName()).append(",");
if (getEdition() != null)
sb.append("Edition: ").append(getEdition()).append(",");
if (getDefaultNamespace() != null)
sb.append("DefaultNamespace: ").append(getDefaultNamespace()).append(",");
if (getNotificationEmail() != null)
sb.append("NotificationEmail: ").append(getNotificationEmail()).append(",");
if (getPublicSharingEnabled() != null)
sb.append("PublicSharingEnabled: ").append(getPublicSharingEnabled()).append(",");
if (getTerminationProtectionEnabled() != null)
sb.append("TerminationProtectionEnabled: ").append(getTerminationProtectionEnabled());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AccountSettings == false)
return false;
AccountSettings other = (AccountSettings) obj;
if (other.getAccountName() == null ^ this.getAccountName() == null)
return false;
if (other.getAccountName() != null && other.getAccountName().equals(this.getAccountName()) == false)
return false;
if (other.getEdition() == null ^ this.getEdition() == null)
return false;
if (other.getEdition() != null && other.getEdition().equals(this.getEdition()) == false)
return false;
if (other.getDefaultNamespace() == null ^ this.getDefaultNamespace() == null)
return false;
if (other.getDefaultNamespace() != null && other.getDefaultNamespace().equals(this.getDefaultNamespace()) == false)
return false;
if (other.getNotificationEmail() == null ^ this.getNotificationEmail() == null)
return false;
if (other.getNotificationEmail() != null && other.getNotificationEmail().equals(this.getNotificationEmail()) == false)
return false;
if (other.getPublicSharingEnabled() == null ^ this.getPublicSharingEnabled() == null)
return false;
if (other.getPublicSharingEnabled() != null && other.getPublicSharingEnabled().equals(this.getPublicSharingEnabled()) == false)
return false;
if (other.getTerminationProtectionEnabled() == null ^ this.getTerminationProtectionEnabled() == null)
return false;
if (other.getTerminationProtectionEnabled() != null && other.getTerminationProtectionEnabled().equals(this.getTerminationProtectionEnabled()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccountName() == null) ? 0 : getAccountName().hashCode());
hashCode = prime * hashCode + ((getEdition() == null) ? 0 : getEdition().hashCode());
hashCode = prime * hashCode + ((getDefaultNamespace() == null) ? 0 : getDefaultNamespace().hashCode());
hashCode = prime * hashCode + ((getNotificationEmail() == null) ? 0 : getNotificationEmail().hashCode());
hashCode = prime * hashCode + ((getPublicSharingEnabled() == null) ? 0 : getPublicSharingEnabled().hashCode());
hashCode = prime * hashCode + ((getTerminationProtectionEnabled() == null) ? 0 : getTerminationProtectionEnabled().hashCode());
return hashCode;
}
@Override
public AccountSettings clone() {
try {
return (AccountSettings) 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.AccountSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}