com.amazonaws.services.quicksight.model.ResourcePermission 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;
/**
*
* Permission for the resource.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ResourcePermission implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
*
* -
*
* The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or
* theme. (This is common.)
*
*
* -
*
* The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option
* only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
*
*
*
*/
private String principal;
/**
*
* The IAM action to grant or revoke permissions on.
*
*/
private java.util.List actions;
/**
*
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
*
* -
*
* The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or
* theme. (This is common.)
*
*
* -
*
* The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option
* only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
*
*
*
*
* @param principal
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
* -
*
* The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard,
* template, or theme. (This is common.)
*
*
* -
*
* The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this
* option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
*
*
*/
public void setPrincipal(String principal) {
this.principal = principal;
}
/**
*
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
*
* -
*
* The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or
* theme. (This is common.)
*
*
* -
*
* The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option
* only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
*
*
*
*
* @return The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
* -
*
* The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard,
* template, or theme. (This is common.)
*
*
* -
*
* The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this
* option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
*
*
*/
public String getPrincipal() {
return this.principal;
}
/**
*
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
*
* -
*
* The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or
* theme. (This is common.)
*
*
* -
*
* The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option
* only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
*
*
*
*
* @param principal
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
* -
*
* The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard,
* template, or theme. (This is common.)
*
*
* -
*
* The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this
* option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourcePermission withPrincipal(String principal) {
setPrincipal(principal);
return this;
}
/**
*
* The IAM action to grant or revoke permissions on.
*
*
* @return The IAM action to grant or revoke permissions on.
*/
public java.util.List getActions() {
return actions;
}
/**
*
* The IAM action to grant or revoke permissions on.
*
*
* @param actions
* The IAM action to grant or revoke permissions on.
*/
public void setActions(java.util.Collection actions) {
if (actions == null) {
this.actions = null;
return;
}
this.actions = new java.util.ArrayList(actions);
}
/**
*
* The IAM action to grant or revoke permissions on.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setActions(java.util.Collection)} or {@link #withActions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param actions
* The IAM action to grant or revoke permissions on.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourcePermission withActions(String... actions) {
if (this.actions == null) {
setActions(new java.util.ArrayList(actions.length));
}
for (String ele : actions) {
this.actions.add(ele);
}
return this;
}
/**
*
* The IAM action to grant or revoke permissions on.
*
*
* @param actions
* The IAM action to grant or revoke permissions on.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourcePermission withActions(java.util.Collection actions) {
setActions(actions);
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 (getPrincipal() != null)
sb.append("Principal: ").append(getPrincipal()).append(",");
if (getActions() != null)
sb.append("Actions: ").append(getActions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ResourcePermission == false)
return false;
ResourcePermission other = (ResourcePermission) obj;
if (other.getPrincipal() == null ^ this.getPrincipal() == null)
return false;
if (other.getPrincipal() != null && other.getPrincipal().equals(this.getPrincipal()) == false)
return false;
if (other.getActions() == null ^ this.getActions() == null)
return false;
if (other.getActions() != null && other.getActions().equals(this.getActions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPrincipal() == null) ? 0 : getPrincipal().hashCode());
hashCode = prime * hashCode + ((getActions() == null) ? 0 : getActions().hashCode());
return hashCode;
}
@Override
public ResourcePermission clone() {
try {
return (ResourcePermission) 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.ResourcePermissionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}