com.amazonaws.services.finspacedata.model.CreatePermissionGroupRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-finspacedata 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.finspacedata.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreatePermissionGroupRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the permission group.
*
*/
private String name;
/**
*
* A brief description for the permission group.
*
*/
private String description;
/**
*
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
* users to grant themselves or others access to any functionality in their FinSpace environment's application. It
* should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
* permission that allows users to grant themselves or others access to any functionality in the application. It
* should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
*
*/
private java.util.List applicationPermissions;
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*/
private String clientToken;
/**
*
* The name of the permission group.
*
*
* @param name
* The name of the permission group.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the permission group.
*
*
* @return The name of the permission group.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the permission group.
*
*
* @param name
* The name of the permission group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePermissionGroupRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A brief description for the permission group.
*
*
* @param description
* A brief description for the permission group.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A brief description for the permission group.
*
*
* @return A brief description for the permission group.
*/
public String getDescription() {
return this.description;
}
/**
*
* A brief description for the permission group.
*
*
* @param description
* A brief description for the permission group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePermissionGroupRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
* users to grant themselves or others access to any functionality in their FinSpace environment's application. It
* should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
* permission that allows users to grant themselves or others access to any functionality in the application. It
* should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
*
*
* @return The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups
* allows users to grant themselves or others access to any functionality in their FinSpace environment's
* application. It should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a
* privileged permission that allows users to grant themselves or others access to any functionality in the
* application. It should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
* @see ApplicationPermission
*/
public java.util.List getApplicationPermissions() {
return applicationPermissions;
}
/**
*
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
* users to grant themselves or others access to any functionality in their FinSpace environment's application. It
* should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
* permission that allows users to grant themselves or others access to any functionality in the application. It
* should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
*
*
* @param applicationPermissions
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups
* allows users to grant themselves or others access to any functionality in their FinSpace environment's
* application. It should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a
* privileged permission that allows users to grant themselves or others access to any functionality in the
* application. It should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
* @see ApplicationPermission
*/
public void setApplicationPermissions(java.util.Collection applicationPermissions) {
if (applicationPermissions == null) {
this.applicationPermissions = null;
return;
}
this.applicationPermissions = new java.util.ArrayList(applicationPermissions);
}
/**
*
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
* users to grant themselves or others access to any functionality in their FinSpace environment's application. It
* should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
* permission that allows users to grant themselves or others access to any functionality in the application. It
* should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setApplicationPermissions(java.util.Collection)} or
* {@link #withApplicationPermissions(java.util.Collection)} if you want to override the existing values.
*
*
* @param applicationPermissions
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups
* allows users to grant themselves or others access to any functionality in their FinSpace environment's
* application. It should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a
* privileged permission that allows users to grant themselves or others access to any functionality in the
* application. It should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApplicationPermission
*/
public CreatePermissionGroupRequest withApplicationPermissions(String... applicationPermissions) {
if (this.applicationPermissions == null) {
setApplicationPermissions(new java.util.ArrayList(applicationPermissions.length));
}
for (String ele : applicationPermissions) {
this.applicationPermissions.add(ele);
}
return this;
}
/**
*
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
* users to grant themselves or others access to any functionality in their FinSpace environment's application. It
* should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
* permission that allows users to grant themselves or others access to any functionality in the application. It
* should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
*
*
* @param applicationPermissions
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups
* allows users to grant themselves or others access to any functionality in their FinSpace environment's
* application. It should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a
* privileged permission that allows users to grant themselves or others access to any functionality in the
* application. It should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApplicationPermission
*/
public CreatePermissionGroupRequest withApplicationPermissions(java.util.Collection applicationPermissions) {
setApplicationPermissions(applicationPermissions);
return this;
}
/**
*
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
* users to grant themselves or others access to any functionality in their FinSpace environment's application. It
* should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
* permission that allows users to grant themselves or others access to any functionality in the application. It
* should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
*
*
* @param applicationPermissions
* The option to indicate FinSpace application permissions that are granted to a specific group.
*
*
* When assigning application permissions, be aware that the permission ManageUsersAndGroups
* allows users to grant themselves or others access to any functionality in their FinSpace environment's
* application. It should only be granted to trusted users.
*
*
*
* -
*
* CreateDataset – Group members can create new datasets.
*
*
* -
*
* ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
*
*
* -
*
* ManageUsersAndGroups – Group members can manage users and permission groups. This is a
* privileged permission that allows users to grant themselves or others access to any functionality in the
* application. It should only be granted to trusted users.
*
*
* -
*
* ManageAttributeSets – Group members can manage attribute sets.
*
*
* -
*
* ViewAuditData – Group members can view audit data.
*
*
* -
*
* AccessNotebooks – Group members will have access to FinSpace notebooks.
*
*
* -
*
* GetTemporaryCredentials – Group members can get temporary API credentials.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApplicationPermission
*/
public CreatePermissionGroupRequest withApplicationPermissions(ApplicationPermission... applicationPermissions) {
java.util.ArrayList applicationPermissionsCopy = new java.util.ArrayList(applicationPermissions.length);
for (ApplicationPermission value : applicationPermissions) {
applicationPermissionsCopy.add(value.toString());
}
if (getApplicationPermissions() == null) {
setApplicationPermissions(applicationPermissionsCopy);
} else {
getApplicationPermissions().addAll(applicationPermissionsCopy);
}
return this;
}
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*
* @param clientToken
* A token that ensures idempotency. This token expires in 10 minutes.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*
* @return A token that ensures idempotency. This token expires in 10 minutes.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*
* @param clientToken
* A token that ensures idempotency. This token expires in 10 minutes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePermissionGroupRequest withClientToken(String clientToken) {
setClientToken(clientToken);
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 (getName() != null)
sb.append("Name: ").append("***Sensitive Data Redacted***").append(",");
if (getDescription() != null)
sb.append("Description: ").append("***Sensitive Data Redacted***").append(",");
if (getApplicationPermissions() != null)
sb.append("ApplicationPermissions: ").append(getApplicationPermissions()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreatePermissionGroupRequest == false)
return false;
CreatePermissionGroupRequest other = (CreatePermissionGroupRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getApplicationPermissions() == null ^ this.getApplicationPermissions() == null)
return false;
if (other.getApplicationPermissions() != null && other.getApplicationPermissions().equals(this.getApplicationPermissions()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getApplicationPermissions() == null) ? 0 : getApplicationPermissions().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public CreatePermissionGroupRequest clone() {
return (CreatePermissionGroupRequest) super.clone();
}
}