software.amazon.awssdk.services.workdocs.model.AddResourcePermissionsRequest Maven / Gradle / Ivy
Show all versions of workdocs 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.workdocs.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 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 AddResourcePermissionsRequest extends WorkDocsRequest implements
ToCopyableBuilder {
private static final SdkField AUTHENTICATION_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthenticationToken").getter(getter(AddResourcePermissionsRequest::authenticationToken))
.setter(setter(Builder::authenticationToken))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Authentication").build()).build();
private static final SdkField RESOURCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceId").getter(getter(AddResourcePermissionsRequest::resourceId))
.setter(setter(Builder::resourceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("ResourceId").build()).build();
private static final SdkField> PRINCIPALS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Principals")
.getter(getter(AddResourcePermissionsRequest::principals))
.setter(setter(Builder::principals))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Principals").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SharePrincipal::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NOTIFICATION_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("NotificationOptions")
.getter(getter(AddResourcePermissionsRequest::notificationOptions)).setter(setter(Builder::notificationOptions))
.constructor(NotificationOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NotificationOptions").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTHENTICATION_TOKEN_FIELD,
RESOURCE_ID_FIELD, PRINCIPALS_FIELD, NOTIFICATION_OPTIONS_FIELD));
private final String authenticationToken;
private final String resourceId;
private final List principals;
private final NotificationOptions notificationOptions;
private AddResourcePermissionsRequest(BuilderImpl builder) {
super(builder);
this.authenticationToken = builder.authenticationToken;
this.resourceId = builder.resourceId;
this.principals = builder.principals;
this.notificationOptions = builder.notificationOptions;
}
/**
*
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to
* access the API.
*
*
* @return Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator
* credentials to access the API.
*/
public final String authenticationToken() {
return authenticationToken;
}
/**
*
* The ID of the resource.
*
*
* @return The ID of the resource.
*/
public final String resourceId() {
return resourceId;
}
/**
* For responses, this returns true if the service returned a value for the Principals 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 hasPrincipals() {
return principals != null && !(principals instanceof SdkAutoConstructList);
}
/**
*
* The users, groups, or organization being granted permission.
*
*
* 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 #hasPrincipals} method.
*
*
* @return The users, groups, or organization being granted permission.
*/
public final List principals() {
return principals;
}
/**
*
* The notification options.
*
*
* @return The notification options.
*/
public final NotificationOptions notificationOptions() {
return notificationOptions;
}
@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(authenticationToken());
hashCode = 31 * hashCode + Objects.hashCode(resourceId());
hashCode = 31 * hashCode + Objects.hashCode(hasPrincipals() ? principals() : null);
hashCode = 31 * hashCode + Objects.hashCode(notificationOptions());
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 AddResourcePermissionsRequest)) {
return false;
}
AddResourcePermissionsRequest other = (AddResourcePermissionsRequest) obj;
return Objects.equals(authenticationToken(), other.authenticationToken())
&& Objects.equals(resourceId(), other.resourceId()) && hasPrincipals() == other.hasPrincipals()
&& Objects.equals(principals(), other.principals())
&& Objects.equals(notificationOptions(), other.notificationOptions());
}
/**
* 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("AddResourcePermissionsRequest")
.add("AuthenticationToken", authenticationToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("ResourceId", resourceId()).add("Principals", hasPrincipals() ? principals() : null)
.add("NotificationOptions", notificationOptions()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AuthenticationToken":
return Optional.ofNullable(clazz.cast(authenticationToken()));
case "ResourceId":
return Optional.ofNullable(clazz.cast(resourceId()));
case "Principals":
return Optional.ofNullable(clazz.cast(principals()));
case "NotificationOptions":
return Optional.ofNullable(clazz.cast(notificationOptions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AddResourcePermissionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkDocsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials
* to access the API.
*
*
* @param authenticationToken
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator
* credentials to access the API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authenticationToken(String authenticationToken);
/**
*
* The ID of the resource.
*
*
* @param resourceId
* The ID of the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceId(String resourceId);
/**
*
* The users, groups, or organization being granted permission.
*
*
* @param principals
* The users, groups, or organization being granted permission.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principals(Collection principals);
/**
*
* The users, groups, or organization being granted permission.
*
*
* @param principals
* The users, groups, or organization being granted permission.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principals(SharePrincipal... principals);
/**
*
* The users, groups, or organization being granted permission.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workdocs.model.SharePrincipal.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.workdocs.model.SharePrincipal#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workdocs.model.SharePrincipal.Builder#build()} is called immediately
* and its result is passed to {@link #principals(List)}.
*
* @param principals
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workdocs.model.SharePrincipal.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #principals(java.util.Collection)
*/
Builder principals(Consumer... principals);
/**
*
* The notification options.
*
*
* @param notificationOptions
* The notification options.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder notificationOptions(NotificationOptions notificationOptions);
/**
*
* The notification options.
*
* This is a convenience method that creates an instance of the {@link NotificationOptions.Builder} avoiding the
* need to create one manually via {@link NotificationOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link NotificationOptions.Builder#build()} is called immediately and
* its result is passed to {@link #notificationOptions(NotificationOptions)}.
*
* @param notificationOptions
* a consumer that will call methods on {@link NotificationOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #notificationOptions(NotificationOptions)
*/
default Builder notificationOptions(Consumer notificationOptions) {
return notificationOptions(NotificationOptions.builder().applyMutation(notificationOptions).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WorkDocsRequest.BuilderImpl implements Builder {
private String authenticationToken;
private String resourceId;
private List principals = DefaultSdkAutoConstructList.getInstance();
private NotificationOptions notificationOptions;
private BuilderImpl() {
}
private BuilderImpl(AddResourcePermissionsRequest model) {
super(model);
authenticationToken(model.authenticationToken);
resourceId(model.resourceId);
principals(model.principals);
notificationOptions(model.notificationOptions);
}
public final String getAuthenticationToken() {
return authenticationToken;
}
public final void setAuthenticationToken(String authenticationToken) {
this.authenticationToken = authenticationToken;
}
@Override
public final Builder authenticationToken(String authenticationToken) {
this.authenticationToken = authenticationToken;
return this;
}
public final String getResourceId() {
return resourceId;
}
public final void setResourceId(String resourceId) {
this.resourceId = resourceId;
}
@Override
public final Builder resourceId(String resourceId) {
this.resourceId = resourceId;
return this;
}
public final List getPrincipals() {
List result = SharePrincipalListCopier.copyToBuilder(this.principals);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPrincipals(Collection principals) {
this.principals = SharePrincipalListCopier.copyFromBuilder(principals);
}
@Override
public final Builder principals(Collection principals) {
this.principals = SharePrincipalListCopier.copy(principals);
return this;
}
@Override
@SafeVarargs
public final Builder principals(SharePrincipal... principals) {
principals(Arrays.asList(principals));
return this;
}
@Override
@SafeVarargs
public final Builder principals(Consumer... principals) {
principals(Stream.of(principals).map(c -> SharePrincipal.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final NotificationOptions.Builder getNotificationOptions() {
return notificationOptions != null ? notificationOptions.toBuilder() : null;
}
public final void setNotificationOptions(NotificationOptions.BuilderImpl notificationOptions) {
this.notificationOptions = notificationOptions != null ? notificationOptions.build() : null;
}
@Override
public final Builder notificationOptions(NotificationOptions notificationOptions) {
this.notificationOptions = notificationOptions;
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 AddResourcePermissionsRequest build() {
return new AddResourcePermissionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}