software.amazon.awssdk.services.finspacedata.model.CreatePermissionGroupRequest Maven / Gradle / Ivy
Show all versions of finspacedata Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.finspacedata.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.DefaultValueTrait;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreatePermissionGroupRequest extends FinspaceDataRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(CreatePermissionGroupRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreatePermissionGroupRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField> APPLICATION_PERMISSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("applicationPermissions")
.getter(getter(CreatePermissionGroupRequest::applicationPermissionsAsStrings))
.setter(setter(Builder::applicationPermissionsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("applicationPermissions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreatePermissionGroupRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, DESCRIPTION_FIELD,
APPLICATION_PERMISSIONS_FIELD, CLIENT_TOKEN_FIELD));
private final String name;
private final String description;
private final List applicationPermissions;
private final String clientToken;
private CreatePermissionGroupRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.description = builder.description;
this.applicationPermissions = builder.applicationPermissions;
this.clientToken = builder.clientToken;
}
/**
*
* The name of the permission group.
*
*
* @return The name of the permission group.
*/
public final String name() {
return name;
}
/**
*
* A brief description for the permission group.
*
*
* @return A brief description for the permission group.
*/
public final String description() {
return 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.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasApplicationPermissions} method.
*
*
* @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.
*
*
*/
public final List applicationPermissions() {
return ApplicationPermissionListCopier.copyStringToEnum(applicationPermissions);
}
/**
* For responses, this returns true if the service returned a value for the ApplicationPermissions property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasApplicationPermissions() {
return applicationPermissions != null && !(applicationPermissions instanceof SdkAutoConstructList);
}
/**
*
* 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.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasApplicationPermissions} method.
*
*
* @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.
*
*
*/
public final List applicationPermissionsAsStrings() {
return applicationPermissions;
}
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*
* @return A token that ensures idempotency. This token expires in 10 minutes.
*/
public final String clientToken() {
return clientToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasApplicationPermissions() ? applicationPermissionsAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreatePermissionGroupRequest)) {
return false;
}
CreatePermissionGroupRequest other = (CreatePermissionGroupRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(description(), other.description())
&& hasApplicationPermissions() == other.hasApplicationPermissions()
&& Objects.equals(applicationPermissionsAsStrings(), other.applicationPermissionsAsStrings())
&& Objects.equals(clientToken(), other.clientToken());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreatePermissionGroupRequest")
.add("Name", name() == null ? null : "*** Sensitive Data Redacted ***")
.add("Description", description() == null ? null : "*** Sensitive Data Redacted ***")
.add("ApplicationPermissions", hasApplicationPermissions() ? applicationPermissionsAsStrings() : null)
.add("ClientToken", clientToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "applicationPermissions":
return Optional.ofNullable(clazz.cast(applicationPermissionsAsStrings()));
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreatePermissionGroupRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends FinspaceDataRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder name(String name);
/**
*
* 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.
*/
Builder description(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.
*
*
*
*
* @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.
*/
Builder applicationPermissionsWithStrings(Collection 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationPermissionsWithStrings(String... 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationPermissions(Collection 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationPermissions(ApplicationPermission... applicationPermissions);
/**
*
* 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.
*/
Builder clientToken(String clientToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends FinspaceDataRequest.BuilderImpl implements Builder {
private String name;
private String description;
private List applicationPermissions = DefaultSdkAutoConstructList.getInstance();
private String clientToken;
private BuilderImpl() {
}
private BuilderImpl(CreatePermissionGroupRequest model) {
super(model);
name(model.name);
description(model.description);
applicationPermissionsWithStrings(model.applicationPermissions);
clientToken(model.clientToken);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final Collection getApplicationPermissions() {
if (applicationPermissions instanceof SdkAutoConstructList) {
return null;
}
return applicationPermissions;
}
public final void setApplicationPermissions(Collection applicationPermissions) {
this.applicationPermissions = ApplicationPermissionListCopier.copy(applicationPermissions);
}
@Override
public final Builder applicationPermissionsWithStrings(Collection applicationPermissions) {
this.applicationPermissions = ApplicationPermissionListCopier.copy(applicationPermissions);
return this;
}
@Override
@SafeVarargs
public final Builder applicationPermissionsWithStrings(String... applicationPermissions) {
applicationPermissionsWithStrings(Arrays.asList(applicationPermissions));
return this;
}
@Override
public final Builder applicationPermissions(Collection applicationPermissions) {
this.applicationPermissions = ApplicationPermissionListCopier.copyEnumToString(applicationPermissions);
return this;
}
@Override
@SafeVarargs
public final Builder applicationPermissions(ApplicationPermission... applicationPermissions) {
applicationPermissions(Arrays.asList(applicationPermissions));
return this;
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreatePermissionGroupRequest build() {
return new CreatePermissionGroupRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}