software.amazon.awssdk.services.workspacesweb.model.CreateUserSettingsRequest Maven / Gradle / Ivy
Show all versions of workspacesweb 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.workspacesweb.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.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 CreateUserSettingsRequest extends WorkSpacesWebRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreateUserSettingsRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField COPY_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("copyAllowed").getter(getter(CreateUserSettingsRequest::copyAllowedAsString))
.setter(setter(Builder::copyAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("copyAllowed").build()).build();
private static final SdkField DOWNLOAD_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("downloadAllowed").getter(getter(CreateUserSettingsRequest::downloadAllowedAsString))
.setter(setter(Builder::downloadAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("downloadAllowed").build()).build();
private static final SdkField PASTE_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("pasteAllowed").getter(getter(CreateUserSettingsRequest::pasteAllowedAsString))
.setter(setter(Builder::pasteAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("pasteAllowed").build()).build();
private static final SdkField PRINT_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("printAllowed").getter(getter(CreateUserSettingsRequest::printAllowedAsString))
.setter(setter(Builder::printAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("printAllowed").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateUserSettingsRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField UPLOAD_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("uploadAllowed").getter(getter(CreateUserSettingsRequest::uploadAllowedAsString))
.setter(setter(Builder::uploadAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("uploadAllowed").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
COPY_ALLOWED_FIELD, DOWNLOAD_ALLOWED_FIELD, PASTE_ALLOWED_FIELD, PRINT_ALLOWED_FIELD, TAGS_FIELD,
UPLOAD_ALLOWED_FIELD));
private final String clientToken;
private final String copyAllowed;
private final String downloadAllowed;
private final String pasteAllowed;
private final String printAllowed;
private final List tags;
private final String uploadAllowed;
private CreateUserSettingsRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.copyAllowed = builder.copyAllowed;
this.downloadAllowed = builder.downloadAllowed;
this.pasteAllowed = builder.pasteAllowed;
this.printAllowed = builder.printAllowed;
this.tags = builder.tags;
this.uploadAllowed = builder.uploadAllowed;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency
* ensures that an API request completes only once. With an idempotent request, if the original request completes
* successfully, subsequent retries with the same client token returns the result from the original successful
* request.
*
*
* If you do not specify a client token, one is automatically generated by the AWS SDK.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
* Idempotency ensures that an API request completes only once. With an idempotent request, if the original
* request completes successfully, subsequent retries with the same client token returns the result from the
* original successful request.
*
* If you do not specify a client token, one is automatically generated by the AWS SDK.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* Specifies whether the user can copy text from the streaming session to the local device.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #copyAllowed} will
* return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #copyAllowedAsString}.
*
*
* @return Specifies whether the user can copy text from the streaming session to the local device.
* @see EnabledType
*/
public final EnabledType copyAllowed() {
return EnabledType.fromValue(copyAllowed);
}
/**
*
* Specifies whether the user can copy text from the streaming session to the local device.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #copyAllowed} will
* return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #copyAllowedAsString}.
*
*
* @return Specifies whether the user can copy text from the streaming session to the local device.
* @see EnabledType
*/
public final String copyAllowedAsString() {
return copyAllowed;
}
/**
*
* Specifies whether the user can download files from the streaming session to the local device.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #downloadAllowed}
* will return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #downloadAllowedAsString}.
*
*
* @return Specifies whether the user can download files from the streaming session to the local device.
* @see EnabledType
*/
public final EnabledType downloadAllowed() {
return EnabledType.fromValue(downloadAllowed);
}
/**
*
* Specifies whether the user can download files from the streaming session to the local device.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #downloadAllowed}
* will return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #downloadAllowedAsString}.
*
*
* @return Specifies whether the user can download files from the streaming session to the local device.
* @see EnabledType
*/
public final String downloadAllowedAsString() {
return downloadAllowed;
}
/**
*
* Specifies whether the user can paste text from the local device to the streaming session.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #pasteAllowed} will
* return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #pasteAllowedAsString}.
*
*
* @return Specifies whether the user can paste text from the local device to the streaming session.
* @see EnabledType
*/
public final EnabledType pasteAllowed() {
return EnabledType.fromValue(pasteAllowed);
}
/**
*
* Specifies whether the user can paste text from the local device to the streaming session.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #pasteAllowed} will
* return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #pasteAllowedAsString}.
*
*
* @return Specifies whether the user can paste text from the local device to the streaming session.
* @see EnabledType
*/
public final String pasteAllowedAsString() {
return pasteAllowed;
}
/**
*
* Specifies whether the user can print to the local device.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #printAllowed} will
* return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #printAllowedAsString}.
*
*
* @return Specifies whether the user can print to the local device.
* @see EnabledType
*/
public final EnabledType printAllowed() {
return EnabledType.fromValue(printAllowed);
}
/**
*
* Specifies whether the user can print to the local device.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #printAllowed} will
* return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #printAllowedAsString}.
*
*
* @return Specifies whether the user can print to the local device.
* @see EnabledType
*/
public final String printAllowedAsString() {
return printAllowed;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* The tags to add to the user settings resource. A tag is a key-value pair.
*
*
* 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 #hasTags} method.
*
*
* @return The tags to add to the user settings resource. A tag is a key-value pair.
*/
public final List tags() {
return tags;
}
/**
*
* Specifies whether the user can upload files from the local device to the streaming session.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #uploadAllowed}
* will return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #uploadAllowedAsString}.
*
*
* @return Specifies whether the user can upload files from the local device to the streaming session.
* @see EnabledType
*/
public final EnabledType uploadAllowed() {
return EnabledType.fromValue(uploadAllowed);
}
/**
*
* Specifies whether the user can upload files from the local device to the streaming session.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #uploadAllowed}
* will return {@link EnabledType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #uploadAllowedAsString}.
*
*
* @return Specifies whether the user can upload files from the local device to the streaming session.
* @see EnabledType
*/
public final String uploadAllowedAsString() {
return uploadAllowed;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(copyAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(downloadAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(pasteAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(printAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(uploadAllowedAsString());
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 CreateUserSettingsRequest)) {
return false;
}
CreateUserSettingsRequest other = (CreateUserSettingsRequest) obj;
return Objects.equals(clientToken(), other.clientToken())
&& Objects.equals(copyAllowedAsString(), other.copyAllowedAsString())
&& Objects.equals(downloadAllowedAsString(), other.downloadAllowedAsString())
&& Objects.equals(pasteAllowedAsString(), other.pasteAllowedAsString())
&& Objects.equals(printAllowedAsString(), other.printAllowedAsString()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(uploadAllowedAsString(), other.uploadAllowedAsString());
}
/**
* 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("CreateUserSettingsRequest").add("ClientToken", clientToken())
.add("CopyAllowed", copyAllowedAsString()).add("DownloadAllowed", downloadAllowedAsString())
.add("PasteAllowed", pasteAllowedAsString()).add("PrintAllowed", printAllowedAsString())
.add("Tags", hasTags() ? tags() : null).add("UploadAllowed", uploadAllowedAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "copyAllowed":
return Optional.ofNullable(clazz.cast(copyAllowedAsString()));
case "downloadAllowed":
return Optional.ofNullable(clazz.cast(downloadAllowedAsString()));
case "pasteAllowed":
return Optional.ofNullable(clazz.cast(pasteAllowedAsString()));
case "printAllowed":
return Optional.ofNullable(clazz.cast(printAllowedAsString()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "uploadAllowed":
return Optional.ofNullable(clazz.cast(uploadAllowedAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function