software.amazon.awssdk.services.workspacesweb.model.UserSettings 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.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
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.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.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A user settings resource that can be associated with a web portal. Once associated with a web portal, user settings
* control how users can transfer data between a streaming session and the their local devices.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UserSettings implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> ADDITIONAL_ENCRYPTION_CONTEXT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("additionalEncryptionContext")
.getter(getter(UserSettings::additionalEncryptionContext))
.setter(setter(Builder::additionalEncryptionContext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("additionalEncryptionContext")
.build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> ASSOCIATED_PORTAL_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("associatedPortalArns")
.getter(getter(UserSettings::associatedPortalArns))
.setter(setter(Builder::associatedPortalArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("associatedPortalArns").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 COOKIE_SYNCHRONIZATION_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("cookieSynchronizationConfiguration")
.getter(getter(UserSettings::cookieSynchronizationConfiguration))
.setter(setter(Builder::cookieSynchronizationConfiguration))
.constructor(CookieSynchronizationConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("cookieSynchronizationConfiguration")
.build()).build();
private static final SdkField COPY_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("copyAllowed").getter(getter(UserSettings::copyAllowedAsString)).setter(setter(Builder::copyAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("copyAllowed").build()).build();
private static final SdkField CUSTOMER_MANAGED_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("customerManagedKey").getter(getter(UserSettings::customerManagedKey))
.setter(setter(Builder::customerManagedKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("customerManagedKey").build())
.build();
private static final SdkField DISCONNECT_TIMEOUT_IN_MINUTES_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("disconnectTimeoutInMinutes")
.getter(getter(UserSettings::disconnectTimeoutInMinutes))
.setter(setter(Builder::disconnectTimeoutInMinutes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("disconnectTimeoutInMinutes").build())
.build();
private static final SdkField DOWNLOAD_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("downloadAllowed").getter(getter(UserSettings::downloadAllowedAsString))
.setter(setter(Builder::downloadAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("downloadAllowed").build()).build();
private static final SdkField IDLE_DISCONNECT_TIMEOUT_IN_MINUTES_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("idleDisconnectTimeoutInMinutes")
.getter(getter(UserSettings::idleDisconnectTimeoutInMinutes))
.setter(setter(Builder::idleDisconnectTimeoutInMinutes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("idleDisconnectTimeoutInMinutes")
.build()).build();
private static final SdkField PASTE_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("pasteAllowed").getter(getter(UserSettings::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(UserSettings::printAllowedAsString)).setter(setter(Builder::printAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("printAllowed").build()).build();
private static final SdkField UPLOAD_ALLOWED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("uploadAllowed").getter(getter(UserSettings::uploadAllowedAsString))
.setter(setter(Builder::uploadAllowed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("uploadAllowed").build()).build();
private static final SdkField USER_SETTINGS_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("userSettingsArn").getter(getter(UserSettings::userSettingsArn)).setter(setter(Builder::userSettingsArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("userSettingsArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
ADDITIONAL_ENCRYPTION_CONTEXT_FIELD, ASSOCIATED_PORTAL_ARNS_FIELD, COOKIE_SYNCHRONIZATION_CONFIGURATION_FIELD,
COPY_ALLOWED_FIELD, CUSTOMER_MANAGED_KEY_FIELD, DISCONNECT_TIMEOUT_IN_MINUTES_FIELD, DOWNLOAD_ALLOWED_FIELD,
IDLE_DISCONNECT_TIMEOUT_IN_MINUTES_FIELD, PASTE_ALLOWED_FIELD, PRINT_ALLOWED_FIELD, UPLOAD_ALLOWED_FIELD,
USER_SETTINGS_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final Map additionalEncryptionContext;
private final List associatedPortalArns;
private final CookieSynchronizationConfiguration cookieSynchronizationConfiguration;
private final String copyAllowed;
private final String customerManagedKey;
private final Integer disconnectTimeoutInMinutes;
private final String downloadAllowed;
private final Integer idleDisconnectTimeoutInMinutes;
private final String pasteAllowed;
private final String printAllowed;
private final String uploadAllowed;
private final String userSettingsArn;
private UserSettings(BuilderImpl builder) {
this.additionalEncryptionContext = builder.additionalEncryptionContext;
this.associatedPortalArns = builder.associatedPortalArns;
this.cookieSynchronizationConfiguration = builder.cookieSynchronizationConfiguration;
this.copyAllowed = builder.copyAllowed;
this.customerManagedKey = builder.customerManagedKey;
this.disconnectTimeoutInMinutes = builder.disconnectTimeoutInMinutes;
this.downloadAllowed = builder.downloadAllowed;
this.idleDisconnectTimeoutInMinutes = builder.idleDisconnectTimeoutInMinutes;
this.pasteAllowed = builder.pasteAllowed;
this.printAllowed = builder.printAllowed;
this.uploadAllowed = builder.uploadAllowed;
this.userSettingsArn = builder.userSettingsArn;
}
/**
* For responses, this returns true if the service returned a value for the AdditionalEncryptionContext 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 hasAdditionalEncryptionContext() {
return additionalEncryptionContext != null && !(additionalEncryptionContext instanceof SdkAutoConstructMap);
}
/**
*
* The additional encryption context of the user settings.
*
*
* 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 #hasAdditionalEncryptionContext} method.
*
*
* @return The additional encryption context of the user settings.
*/
public final Map additionalEncryptionContext() {
return additionalEncryptionContext;
}
/**
* For responses, this returns true if the service returned a value for the AssociatedPortalArns 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 hasAssociatedPortalArns() {
return associatedPortalArns != null && !(associatedPortalArns instanceof SdkAutoConstructList);
}
/**
*
* A list of web portal ARNs that this user settings is associated with.
*
*
* 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 #hasAssociatedPortalArns} method.
*
*
* @return A list of web portal ARNs that this user settings is associated with.
*/
public final List associatedPortalArns() {
return associatedPortalArns;
}
/**
*
* The configuration that specifies which cookies should be synchronized from the end user's local browser to the
* remote browser.
*
*
* @return The configuration that specifies which cookies should be synchronized from the end user's local browser
* to the remote browser.
*/
public final CookieSynchronizationConfiguration cookieSynchronizationConfiguration() {
return cookieSynchronizationConfiguration;
}
/**
*
* 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;
}
/**
*
* The customer managed key used to encrypt sensitive information in the user settings.
*
*
* @return The customer managed key used to encrypt sensitive information in the user settings.
*/
public final String customerManagedKey() {
return customerManagedKey;
}
/**
*
* The amount of time that a streaming session remains active after users disconnect.
*
*
* @return The amount of time that a streaming session remains active after users disconnect.
*/
public final Integer disconnectTimeoutInMinutes() {
return disconnectTimeoutInMinutes;
}
/**
*
* 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;
}
/**
*
* The amount of time that users can be idle (inactive) before they are disconnected from their streaming session
* and the disconnect timeout interval begins.
*
*
* @return The amount of time that users can be idle (inactive) before they are disconnected from their streaming
* session and the disconnect timeout interval begins.
*/
public final Integer idleDisconnectTimeoutInMinutes() {
return idleDisconnectTimeoutInMinutes;
}
/**
*
* 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;
}
/**
*
* 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;
}
/**
*
* The ARN of the user settings.
*
*
* @return The ARN of the user settings.
*/
public final String userSettingsArn() {
return userSettingsArn;
}
@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 + Objects.hashCode(hasAdditionalEncryptionContext() ? additionalEncryptionContext() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAssociatedPortalArns() ? associatedPortalArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(cookieSynchronizationConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(copyAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(customerManagedKey());
hashCode = 31 * hashCode + Objects.hashCode(disconnectTimeoutInMinutes());
hashCode = 31 * hashCode + Objects.hashCode(downloadAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(idleDisconnectTimeoutInMinutes());
hashCode = 31 * hashCode + Objects.hashCode(pasteAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(printAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(uploadAllowedAsString());
hashCode = 31 * hashCode + Objects.hashCode(userSettingsArn());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UserSettings)) {
return false;
}
UserSettings other = (UserSettings) obj;
return hasAdditionalEncryptionContext() == other.hasAdditionalEncryptionContext()
&& Objects.equals(additionalEncryptionContext(), other.additionalEncryptionContext())
&& hasAssociatedPortalArns() == other.hasAssociatedPortalArns()
&& Objects.equals(associatedPortalArns(), other.associatedPortalArns())
&& Objects.equals(cookieSynchronizationConfiguration(), other.cookieSynchronizationConfiguration())
&& Objects.equals(copyAllowedAsString(), other.copyAllowedAsString())
&& Objects.equals(customerManagedKey(), other.customerManagedKey())
&& Objects.equals(disconnectTimeoutInMinutes(), other.disconnectTimeoutInMinutes())
&& Objects.equals(downloadAllowedAsString(), other.downloadAllowedAsString())
&& Objects.equals(idleDisconnectTimeoutInMinutes(), other.idleDisconnectTimeoutInMinutes())
&& Objects.equals(pasteAllowedAsString(), other.pasteAllowedAsString())
&& Objects.equals(printAllowedAsString(), other.printAllowedAsString())
&& Objects.equals(uploadAllowedAsString(), other.uploadAllowedAsString())
&& Objects.equals(userSettingsArn(), other.userSettingsArn());
}
/**
* 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("UserSettings")
.add("AdditionalEncryptionContext", hasAdditionalEncryptionContext() ? additionalEncryptionContext() : null)
.add("AssociatedPortalArns", hasAssociatedPortalArns() ? associatedPortalArns() : null)
.add("CookieSynchronizationConfiguration",
cookieSynchronizationConfiguration() == null ? null : "*** Sensitive Data Redacted ***")
.add("CopyAllowed", copyAllowedAsString()).add("CustomerManagedKey", customerManagedKey())
.add("DisconnectTimeoutInMinutes", disconnectTimeoutInMinutes())
.add("DownloadAllowed", downloadAllowedAsString())
.add("IdleDisconnectTimeoutInMinutes", idleDisconnectTimeoutInMinutes())
.add("PasteAllowed", pasteAllowedAsString()).add("PrintAllowed", printAllowedAsString())
.add("UploadAllowed", uploadAllowedAsString()).add("UserSettingsArn", userSettingsArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "additionalEncryptionContext":
return Optional.ofNullable(clazz.cast(additionalEncryptionContext()));
case "associatedPortalArns":
return Optional.ofNullable(clazz.cast(associatedPortalArns()));
case "cookieSynchronizationConfiguration":
return Optional.ofNullable(clazz.cast(cookieSynchronizationConfiguration()));
case "copyAllowed":
return Optional.ofNullable(clazz.cast(copyAllowedAsString()));
case "customerManagedKey":
return Optional.ofNullable(clazz.cast(customerManagedKey()));
case "disconnectTimeoutInMinutes":
return Optional.ofNullable(clazz.cast(disconnectTimeoutInMinutes()));
case "downloadAllowed":
return Optional.ofNullable(clazz.cast(downloadAllowedAsString()));
case "idleDisconnectTimeoutInMinutes":
return Optional.ofNullable(clazz.cast(idleDisconnectTimeoutInMinutes()));
case "pasteAllowed":
return Optional.ofNullable(clazz.cast(pasteAllowedAsString()));
case "printAllowed":
return Optional.ofNullable(clazz.cast(printAllowedAsString()));
case "uploadAllowed":
return Optional.ofNullable(clazz.cast(uploadAllowedAsString()));
case "userSettingsArn":
return Optional.ofNullable(clazz.cast(userSettingsArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UserSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The additional encryption context of the user settings.
*
*
* @param additionalEncryptionContext
* The additional encryption context of the user settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder additionalEncryptionContext(Map additionalEncryptionContext);
/**
*
* A list of web portal ARNs that this user settings is associated with.
*
*
* @param associatedPortalArns
* A list of web portal ARNs that this user settings is associated with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder associatedPortalArns(Collection associatedPortalArns);
/**
*
* A list of web portal ARNs that this user settings is associated with.
*
*
* @param associatedPortalArns
* A list of web portal ARNs that this user settings is associated with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder associatedPortalArns(String... associatedPortalArns);
/**
*
* The configuration that specifies which cookies should be synchronized from the end user's local browser to
* the remote browser.
*
*
* @param cookieSynchronizationConfiguration
* The configuration that specifies which cookies should be synchronized from the end user's local
* browser to the remote browser.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cookieSynchronizationConfiguration(CookieSynchronizationConfiguration cookieSynchronizationConfiguration);
/**
*
* The configuration that specifies which cookies should be synchronized from the end user's local browser to
* the remote browser.
*
* This is a convenience method that creates an instance of the
* {@link CookieSynchronizationConfiguration.Builder} avoiding the need to create one manually via
* {@link CookieSynchronizationConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link CookieSynchronizationConfiguration.Builder#build()} is called
* immediately and its result is passed to
* {@link #cookieSynchronizationConfiguration(CookieSynchronizationConfiguration)}.
*
* @param cookieSynchronizationConfiguration
* a consumer that will call methods on {@link CookieSynchronizationConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #cookieSynchronizationConfiguration(CookieSynchronizationConfiguration)
*/
default Builder cookieSynchronizationConfiguration(
Consumer cookieSynchronizationConfiguration) {
return cookieSynchronizationConfiguration(CookieSynchronizationConfiguration.builder()
.applyMutation(cookieSynchronizationConfiguration).build());
}
/**
*
* Specifies whether the user can copy text from the streaming session to the local device.
*
*
* @param copyAllowed
* Specifies whether the user can copy text from the streaming session to the local device.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder copyAllowed(String copyAllowed);
/**
*
* Specifies whether the user can copy text from the streaming session to the local device.
*
*
* @param copyAllowed
* Specifies whether the user can copy text from the streaming session to the local device.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder copyAllowed(EnabledType copyAllowed);
/**
*
* The customer managed key used to encrypt sensitive information in the user settings.
*
*
* @param customerManagedKey
* The customer managed key used to encrypt sensitive information in the user settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customerManagedKey(String customerManagedKey);
/**
*
* The amount of time that a streaming session remains active after users disconnect.
*
*
* @param disconnectTimeoutInMinutes
* The amount of time that a streaming session remains active after users disconnect.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder disconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes);
/**
*
* Specifies whether the user can download files from the streaming session to the local device.
*
*
* @param downloadAllowed
* Specifies whether the user can download files from the streaming session to the local device.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder downloadAllowed(String downloadAllowed);
/**
*
* Specifies whether the user can download files from the streaming session to the local device.
*
*
* @param downloadAllowed
* Specifies whether the user can download files from the streaming session to the local device.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder downloadAllowed(EnabledType downloadAllowed);
/**
*
* The amount of time that users can be idle (inactive) before they are disconnected from their streaming
* session and the disconnect timeout interval begins.
*
*
* @param idleDisconnectTimeoutInMinutes
* The amount of time that users can be idle (inactive) before they are disconnected from their streaming
* session and the disconnect timeout interval begins.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder idleDisconnectTimeoutInMinutes(Integer idleDisconnectTimeoutInMinutes);
/**
*
* Specifies whether the user can paste text from the local device to the streaming session.
*
*
* @param pasteAllowed
* Specifies whether the user can paste text from the local device to the streaming session.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder pasteAllowed(String pasteAllowed);
/**
*
* Specifies whether the user can paste text from the local device to the streaming session.
*
*
* @param pasteAllowed
* Specifies whether the user can paste text from the local device to the streaming session.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder pasteAllowed(EnabledType pasteAllowed);
/**
*
* Specifies whether the user can print to the local device.
*
*
* @param printAllowed
* Specifies whether the user can print to the local device.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder printAllowed(String printAllowed);
/**
*
* Specifies whether the user can print to the local device.
*
*
* @param printAllowed
* Specifies whether the user can print to the local device.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder printAllowed(EnabledType printAllowed);
/**
*
* Specifies whether the user can upload files from the local device to the streaming session.
*
*
* @param uploadAllowed
* Specifies whether the user can upload files from the local device to the streaming session.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder uploadAllowed(String uploadAllowed);
/**
*
* Specifies whether the user can upload files from the local device to the streaming session.
*
*
* @param uploadAllowed
* Specifies whether the user can upload files from the local device to the streaming session.
* @see EnabledType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EnabledType
*/
Builder uploadAllowed(EnabledType uploadAllowed);
/**
*
* The ARN of the user settings.
*
*
* @param userSettingsArn
* The ARN of the user settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userSettingsArn(String userSettingsArn);
}
static final class BuilderImpl implements Builder {
private Map additionalEncryptionContext = DefaultSdkAutoConstructMap.getInstance();
private List associatedPortalArns = DefaultSdkAutoConstructList.getInstance();
private CookieSynchronizationConfiguration cookieSynchronizationConfiguration;
private String copyAllowed;
private String customerManagedKey;
private Integer disconnectTimeoutInMinutes;
private String downloadAllowed;
private Integer idleDisconnectTimeoutInMinutes;
private String pasteAllowed;
private String printAllowed;
private String uploadAllowed;
private String userSettingsArn;
private BuilderImpl() {
}
private BuilderImpl(UserSettings model) {
additionalEncryptionContext(model.additionalEncryptionContext);
associatedPortalArns(model.associatedPortalArns);
cookieSynchronizationConfiguration(model.cookieSynchronizationConfiguration);
copyAllowed(model.copyAllowed);
customerManagedKey(model.customerManagedKey);
disconnectTimeoutInMinutes(model.disconnectTimeoutInMinutes);
downloadAllowed(model.downloadAllowed);
idleDisconnectTimeoutInMinutes(model.idleDisconnectTimeoutInMinutes);
pasteAllowed(model.pasteAllowed);
printAllowed(model.printAllowed);
uploadAllowed(model.uploadAllowed);
userSettingsArn(model.userSettingsArn);
}
public final Map getAdditionalEncryptionContext() {
if (additionalEncryptionContext instanceof SdkAutoConstructMap) {
return null;
}
return additionalEncryptionContext;
}
public final void setAdditionalEncryptionContext(Map additionalEncryptionContext) {
this.additionalEncryptionContext = EncryptionContextMapCopier.copy(additionalEncryptionContext);
}
@Override
public final Builder additionalEncryptionContext(Map additionalEncryptionContext) {
this.additionalEncryptionContext = EncryptionContextMapCopier.copy(additionalEncryptionContext);
return this;
}
public final Collection getAssociatedPortalArns() {
if (associatedPortalArns instanceof SdkAutoConstructList) {
return null;
}
return associatedPortalArns;
}
public final void setAssociatedPortalArns(Collection associatedPortalArns) {
this.associatedPortalArns = ArnListCopier.copy(associatedPortalArns);
}
@Override
public final Builder associatedPortalArns(Collection associatedPortalArns) {
this.associatedPortalArns = ArnListCopier.copy(associatedPortalArns);
return this;
}
@Override
@SafeVarargs
public final Builder associatedPortalArns(String... associatedPortalArns) {
associatedPortalArns(Arrays.asList(associatedPortalArns));
return this;
}
public final CookieSynchronizationConfiguration.Builder getCookieSynchronizationConfiguration() {
return cookieSynchronizationConfiguration != null ? cookieSynchronizationConfiguration.toBuilder() : null;
}
public final void setCookieSynchronizationConfiguration(
CookieSynchronizationConfiguration.BuilderImpl cookieSynchronizationConfiguration) {
this.cookieSynchronizationConfiguration = cookieSynchronizationConfiguration != null ? cookieSynchronizationConfiguration
.build() : null;
}
@Override
public final Builder cookieSynchronizationConfiguration(
CookieSynchronizationConfiguration cookieSynchronizationConfiguration) {
this.cookieSynchronizationConfiguration = cookieSynchronizationConfiguration;
return this;
}
public final String getCopyAllowed() {
return copyAllowed;
}
public final void setCopyAllowed(String copyAllowed) {
this.copyAllowed = copyAllowed;
}
@Override
public final Builder copyAllowed(String copyAllowed) {
this.copyAllowed = copyAllowed;
return this;
}
@Override
public final Builder copyAllowed(EnabledType copyAllowed) {
this.copyAllowed(copyAllowed == null ? null : copyAllowed.toString());
return this;
}
public final String getCustomerManagedKey() {
return customerManagedKey;
}
public final void setCustomerManagedKey(String customerManagedKey) {
this.customerManagedKey = customerManagedKey;
}
@Override
public final Builder customerManagedKey(String customerManagedKey) {
this.customerManagedKey = customerManagedKey;
return this;
}
public final Integer getDisconnectTimeoutInMinutes() {
return disconnectTimeoutInMinutes;
}
public final void setDisconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes) {
this.disconnectTimeoutInMinutes = disconnectTimeoutInMinutes;
}
@Override
public final Builder disconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes) {
this.disconnectTimeoutInMinutes = disconnectTimeoutInMinutes;
return this;
}
public final String getDownloadAllowed() {
return downloadAllowed;
}
public final void setDownloadAllowed(String downloadAllowed) {
this.downloadAllowed = downloadAllowed;
}
@Override
public final Builder downloadAllowed(String downloadAllowed) {
this.downloadAllowed = downloadAllowed;
return this;
}
@Override
public final Builder downloadAllowed(EnabledType downloadAllowed) {
this.downloadAllowed(downloadAllowed == null ? null : downloadAllowed.toString());
return this;
}
public final Integer getIdleDisconnectTimeoutInMinutes() {
return idleDisconnectTimeoutInMinutes;
}
public final void setIdleDisconnectTimeoutInMinutes(Integer idleDisconnectTimeoutInMinutes) {
this.idleDisconnectTimeoutInMinutes = idleDisconnectTimeoutInMinutes;
}
@Override
public final Builder idleDisconnectTimeoutInMinutes(Integer idleDisconnectTimeoutInMinutes) {
this.idleDisconnectTimeoutInMinutes = idleDisconnectTimeoutInMinutes;
return this;
}
public final String getPasteAllowed() {
return pasteAllowed;
}
public final void setPasteAllowed(String pasteAllowed) {
this.pasteAllowed = pasteAllowed;
}
@Override
public final Builder pasteAllowed(String pasteAllowed) {
this.pasteAllowed = pasteAllowed;
return this;
}
@Override
public final Builder pasteAllowed(EnabledType pasteAllowed) {
this.pasteAllowed(pasteAllowed == null ? null : pasteAllowed.toString());
return this;
}
public final String getPrintAllowed() {
return printAllowed;
}
public final void setPrintAllowed(String printAllowed) {
this.printAllowed = printAllowed;
}
@Override
public final Builder printAllowed(String printAllowed) {
this.printAllowed = printAllowed;
return this;
}
@Override
public final Builder printAllowed(EnabledType printAllowed) {
this.printAllowed(printAllowed == null ? null : printAllowed.toString());
return this;
}
public final String getUploadAllowed() {
return uploadAllowed;
}
public final void setUploadAllowed(String uploadAllowed) {
this.uploadAllowed = uploadAllowed;
}
@Override
public final Builder uploadAllowed(String uploadAllowed) {
this.uploadAllowed = uploadAllowed;
return this;
}
@Override
public final Builder uploadAllowed(EnabledType uploadAllowed) {
this.uploadAllowed(uploadAllowed == null ? null : uploadAllowed.toString());
return this;
}
public final String getUserSettingsArn() {
return userSettingsArn;
}
public final void setUserSettingsArn(String userSettingsArn) {
this.userSettingsArn = userSettingsArn;
}
@Override
public final Builder userSettingsArn(String userSettingsArn) {
this.userSettingsArn = userSettingsArn;
return this;
}
@Override
public UserSettings build() {
return new UserSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}