software.amazon.awssdk.services.quicksight.model.UpdateFolderPermissionsRequest Maven / Gradle / Ivy
/*
* 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.quicksight.model;
import java.beans.Transient;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.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 UpdateFolderPermissionsRequest extends QuickSightRequest implements
ToCopyableBuilder {
private static final SdkField AWS_ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AwsAccountId").getter(getter(UpdateFolderPermissionsRequest::awsAccountId))
.setter(setter(Builder::awsAccountId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("AwsAccountId").build()).build();
private static final SdkField FOLDER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FolderId").getter(getter(UpdateFolderPermissionsRequest::folderId)).setter(setter(Builder::folderId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("FolderId").build()).build();
private static final SdkField> GRANT_PERMISSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("GrantPermissions")
.getter(getter(UpdateFolderPermissionsRequest::grantPermissions))
.setter(setter(Builder::grantPermissions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GrantPermissions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResourcePermission::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> REVOKE_PERMISSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("RevokePermissions")
.getter(getter(UpdateFolderPermissionsRequest::revokePermissions))
.setter(setter(Builder::revokePermissions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RevokePermissions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResourcePermission::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AWS_ACCOUNT_ID_FIELD,
FOLDER_ID_FIELD, GRANT_PERMISSIONS_FIELD, REVOKE_PERMISSIONS_FIELD));
private final String awsAccountId;
private final String folderId;
private final List grantPermissions;
private final List revokePermissions;
private UpdateFolderPermissionsRequest(BuilderImpl builder) {
super(builder);
this.awsAccountId = builder.awsAccountId;
this.folderId = builder.folderId;
this.grantPermissions = builder.grantPermissions;
this.revokePermissions = builder.revokePermissions;
}
/**
*
* The AWS account ID.
*
*
* @return The AWS account ID.
*/
public final String awsAccountId() {
return awsAccountId;
}
/**
*
* The folder ID.
*
*
* @return The folder ID.
*/
public final String folderId() {
return folderId;
}
/**
* For responses, this returns true if the service returned a value for the GrantPermissions 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 hasGrantPermissions() {
return grantPermissions != null && !(grantPermissions instanceof SdkAutoConstructList);
}
/**
*
* The permissions that you want to grant on a resource.
*
*
* 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 #hasGrantPermissions} method.
*
*
* @return The permissions that you want to grant on a resource.
*/
public final List grantPermissions() {
return grantPermissions;
}
/**
* For responses, this returns true if the service returned a value for the RevokePermissions 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 hasRevokePermissions() {
return revokePermissions != null && !(revokePermissions instanceof SdkAutoConstructList);
}
/**
*
* The permissions that you want to revoke from a resource.
*
*
* 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 #hasRevokePermissions} method.
*
*
* @return The permissions that you want to revoke from a resource.
*/
public final List revokePermissions() {
return revokePermissions;
}
@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(awsAccountId());
hashCode = 31 * hashCode + Objects.hashCode(folderId());
hashCode = 31 * hashCode + Objects.hashCode(hasGrantPermissions() ? grantPermissions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasRevokePermissions() ? revokePermissions() : null);
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 UpdateFolderPermissionsRequest)) {
return false;
}
UpdateFolderPermissionsRequest other = (UpdateFolderPermissionsRequest) obj;
return Objects.equals(awsAccountId(), other.awsAccountId()) && Objects.equals(folderId(), other.folderId())
&& hasGrantPermissions() == other.hasGrantPermissions()
&& Objects.equals(grantPermissions(), other.grantPermissions())
&& hasRevokePermissions() == other.hasRevokePermissions()
&& Objects.equals(revokePermissions(), other.revokePermissions());
}
/**
* 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("UpdateFolderPermissionsRequest").add("AwsAccountId", awsAccountId()).add("FolderId", folderId())
.add("GrantPermissions", hasGrantPermissions() ? grantPermissions() : null)
.add("RevokePermissions", hasRevokePermissions() ? revokePermissions() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AwsAccountId":
return Optional.ofNullable(clazz.cast(awsAccountId()));
case "FolderId":
return Optional.ofNullable(clazz.cast(folderId()));
case "GrantPermissions":
return Optional.ofNullable(clazz.cast(grantPermissions()));
case "RevokePermissions":
return Optional.ofNullable(clazz.cast(revokePermissions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateFolderPermissionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The AWS account ID.
*
*
* @param awsAccountId
* The AWS account ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder awsAccountId(String awsAccountId);
/**
*
* The folder ID.
*
*
* @param folderId
* The folder ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder folderId(String folderId);
/**
*
* The permissions that you want to grant on a resource.
*
*
* @param grantPermissions
* The permissions that you want to grant on a resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantPermissions(Collection grantPermissions);
/**
*
* The permissions that you want to grant on a resource.
*
*
* @param grantPermissions
* The permissions that you want to grant on a resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantPermissions(ResourcePermission... grantPermissions);
/**
*
* The permissions that you want to grant on a resource.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #grantPermissions(List)}.
*
* @param grantPermissions
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #grantPermissions(List)
*/
Builder grantPermissions(Consumer... grantPermissions);
/**
*
* The permissions that you want to revoke from a resource.
*
*
* @param revokePermissions
* The permissions that you want to revoke from a resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder revokePermissions(Collection revokePermissions);
/**
*
* The permissions that you want to revoke from a resource.
*
*
* @param revokePermissions
* The permissions that you want to revoke from a resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder revokePermissions(ResourcePermission... revokePermissions);
/**
*
* The permissions that you want to revoke from a resource.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #revokePermissions(List)}.
*
* @param revokePermissions
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #revokePermissions(List)
*/
Builder revokePermissions(Consumer... revokePermissions);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends QuickSightRequest.BuilderImpl implements Builder {
private String awsAccountId;
private String folderId;
private List grantPermissions = DefaultSdkAutoConstructList.getInstance();
private List revokePermissions = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpdateFolderPermissionsRequest model) {
super(model);
awsAccountId(model.awsAccountId);
folderId(model.folderId);
grantPermissions(model.grantPermissions);
revokePermissions(model.revokePermissions);
}
public final String getAwsAccountId() {
return awsAccountId;
}
public final void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
@Override
@Transient
public final Builder awsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
return this;
}
public final String getFolderId() {
return folderId;
}
public final void setFolderId(String folderId) {
this.folderId = folderId;
}
@Override
@Transient
public final Builder folderId(String folderId) {
this.folderId = folderId;
return this;
}
public final List getGrantPermissions() {
List result = ResourcePermissionListCopier.copyToBuilder(this.grantPermissions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setGrantPermissions(Collection grantPermissions) {
this.grantPermissions = ResourcePermissionListCopier.copyFromBuilder(grantPermissions);
}
@Override
@Transient
public final Builder grantPermissions(Collection grantPermissions) {
this.grantPermissions = ResourcePermissionListCopier.copy(grantPermissions);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder grantPermissions(ResourcePermission... grantPermissions) {
grantPermissions(Arrays.asList(grantPermissions));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder grantPermissions(Consumer... grantPermissions) {
grantPermissions(Stream.of(grantPermissions).map(c -> ResourcePermission.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getRevokePermissions() {
List result = ResourcePermissionListCopier.copyToBuilder(this.revokePermissions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRevokePermissions(Collection revokePermissions) {
this.revokePermissions = ResourcePermissionListCopier.copyFromBuilder(revokePermissions);
}
@Override
@Transient
public final Builder revokePermissions(Collection revokePermissions) {
this.revokePermissions = ResourcePermissionListCopier.copy(revokePermissions);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder revokePermissions(ResourcePermission... revokePermissions) {
revokePermissions(Arrays.asList(revokePermissions));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder revokePermissions(Consumer... revokePermissions) {
revokePermissions(Stream.of(revokePermissions).map(c -> ResourcePermission.builder().applyMutation(c).build())
.collect(Collectors.toList()));
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 UpdateFolderPermissionsRequest build() {
return new UpdateFolderPermissionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy