software.amazon.awssdk.services.workspacesweb.model.CookieSynchronizationConfiguration 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.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.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;
/**
*
* The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote
* browser.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CookieSynchronizationConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> ALLOWLIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("allowlist")
.getter(getter(CookieSynchronizationConfiguration::allowlist))
.setter(setter(Builder::allowlist))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("allowlist").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CookieSpecification::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> BLOCKLIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("blocklist")
.getter(getter(CookieSynchronizationConfiguration::blocklist))
.setter(setter(Builder::blocklist))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("blocklist").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CookieSpecification::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ALLOWLIST_FIELD,
BLOCKLIST_FIELD));
private static final long serialVersionUID = 1L;
private final List allowlist;
private final List blocklist;
private CookieSynchronizationConfiguration(BuilderImpl builder) {
this.allowlist = builder.allowlist;
this.blocklist = builder.blocklist;
}
/**
* For responses, this returns true if the service returned a value for the Allowlist 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 hasAllowlist() {
return allowlist != null && !(allowlist instanceof SdkAutoConstructList);
}
/**
*
* The list of cookie specifications that are allowed to be synchronized to the remote browser.
*
*
* 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 #hasAllowlist} method.
*
*
* @return The list of cookie specifications that are allowed to be synchronized to the remote browser.
*/
public final List allowlist() {
return allowlist;
}
/**
* For responses, this returns true if the service returned a value for the Blocklist 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 hasBlocklist() {
return blocklist != null && !(blocklist instanceof SdkAutoConstructList);
}
/**
*
* The list of cookie specifications that are blocked from being synchronized to the remote browser.
*
*
* 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 #hasBlocklist} method.
*
*
* @return The list of cookie specifications that are blocked from being synchronized to the remote browser.
*/
public final List blocklist() {
return blocklist;
}
@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(hasAllowlist() ? allowlist() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasBlocklist() ? blocklist() : null);
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 CookieSynchronizationConfiguration)) {
return false;
}
CookieSynchronizationConfiguration other = (CookieSynchronizationConfiguration) obj;
return hasAllowlist() == other.hasAllowlist() && Objects.equals(allowlist(), other.allowlist())
&& hasBlocklist() == other.hasBlocklist() && Objects.equals(blocklist(), other.blocklist());
}
/**
* 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("CookieSynchronizationConfiguration").add("Allowlist", hasAllowlist() ? allowlist() : null)
.add("Blocklist", hasBlocklist() ? blocklist() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "allowlist":
return Optional.ofNullable(clazz.cast(allowlist()));
case "blocklist":
return Optional.ofNullable(clazz.cast(blocklist()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CookieSynchronizationConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The list of cookie specifications that are allowed to be synchronized to the remote browser.
*
*
* @param allowlist
* The list of cookie specifications that are allowed to be synchronized to the remote browser.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowlist(Collection allowlist);
/**
*
* The list of cookie specifications that are allowed to be synchronized to the remote browser.
*
*
* @param allowlist
* The list of cookie specifications that are allowed to be synchronized to the remote browser.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowlist(CookieSpecification... allowlist);
/**
*
* The list of cookie specifications that are allowed to be synchronized to the remote browser.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workspacesweb.model.CookieSpecification.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.workspacesweb.model.CookieSpecification#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workspacesweb.model.CookieSpecification.Builder#build()} is called
* immediately and its result is passed to {@link #allowlist(List)}.
*
* @param allowlist
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workspacesweb.model.CookieSpecification.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #allowlist(java.util.Collection)
*/
Builder allowlist(Consumer... allowlist);
/**
*
* The list of cookie specifications that are blocked from being synchronized to the remote browser.
*
*
* @param blocklist
* The list of cookie specifications that are blocked from being synchronized to the remote browser.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blocklist(Collection blocklist);
/**
*
* The list of cookie specifications that are blocked from being synchronized to the remote browser.
*
*
* @param blocklist
* The list of cookie specifications that are blocked from being synchronized to the remote browser.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blocklist(CookieSpecification... blocklist);
/**
*
* The list of cookie specifications that are blocked from being synchronized to the remote browser.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workspacesweb.model.CookieSpecification.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.workspacesweb.model.CookieSpecification#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workspacesweb.model.CookieSpecification.Builder#build()} is called
* immediately and its result is passed to {@link #blocklist(List)}.
*
* @param blocklist
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workspacesweb.model.CookieSpecification.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #blocklist(java.util.Collection)
*/
Builder blocklist(Consumer... blocklist);
}
static final class BuilderImpl implements Builder {
private List allowlist = DefaultSdkAutoConstructList.getInstance();
private List blocklist = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CookieSynchronizationConfiguration model) {
allowlist(model.allowlist);
blocklist(model.blocklist);
}
public final List getAllowlist() {
List result = CookieSpecificationsCopier.copyToBuilder(this.allowlist);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAllowlist(Collection allowlist) {
this.allowlist = CookieSpecificationsCopier.copyFromBuilder(allowlist);
}
@Override
public final Builder allowlist(Collection allowlist) {
this.allowlist = CookieSpecificationsCopier.copy(allowlist);
return this;
}
@Override
@SafeVarargs
public final Builder allowlist(CookieSpecification... allowlist) {
allowlist(Arrays.asList(allowlist));
return this;
}
@Override
@SafeVarargs
public final Builder allowlist(Consumer... allowlist) {
allowlist(Stream.of(allowlist).map(c -> CookieSpecification.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getBlocklist() {
List result = CookieSpecificationsCopier.copyToBuilder(this.blocklist);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setBlocklist(Collection blocklist) {
this.blocklist = CookieSpecificationsCopier.copyFromBuilder(blocklist);
}
@Override
public final Builder blocklist(Collection blocklist) {
this.blocklist = CookieSpecificationsCopier.copy(blocklist);
return this;
}
@Override
@SafeVarargs
public final Builder blocklist(CookieSpecification... blocklist) {
blocklist(Arrays.asList(blocklist));
return this;
}
@Override
@SafeVarargs
public final Builder blocklist(Consumer... blocklist) {
blocklist(Stream.of(blocklist).map(c -> CookieSpecification.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public CookieSynchronizationConfiguration build() {
return new CookieSynchronizationConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}