software.amazon.awssdk.services.workspacesweb.model.BrowserSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of workspacesweb Show documentation
Show all versions of workspacesweb Show documentation
The AWS Java SDK for Work Spaces Web module holds the client classes that are used for
communicating with Work Spaces Web.
/*
* 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.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.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 browser settings resource that can be associated with a web portal. Once associated with a web portal, browser
* settings control how the browser will behave once a user starts a streaming session for the web portal.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BrowserSettings implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> ASSOCIATED_PORTAL_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("associatedPortalArns")
.getter(getter(BrowserSettings::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 BROWSER_POLICY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("browserPolicy").getter(getter(BrowserSettings::browserPolicy)).setter(setter(Builder::browserPolicy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("browserPolicy").build()).build();
private static final SdkField BROWSER_SETTINGS_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("browserSettingsArn").getter(getter(BrowserSettings::browserSettingsArn))
.setter(setter(Builder::browserSettingsArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("browserSettingsArn").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ASSOCIATED_PORTAL_ARNS_FIELD,
BROWSER_POLICY_FIELD, BROWSER_SETTINGS_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final List associatedPortalArns;
private final String browserPolicy;
private final String browserSettingsArn;
private BrowserSettings(BuilderImpl builder) {
this.associatedPortalArns = builder.associatedPortalArns;
this.browserPolicy = builder.browserPolicy;
this.browserSettingsArn = builder.browserSettingsArn;
}
/**
* 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 browser 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 browser settings is associated with.
*/
public final List associatedPortalArns() {
return associatedPortalArns;
}
/**
*
* A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
*
*
* @return A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
*/
public final String browserPolicy() {
return browserPolicy;
}
/**
*
* The ARN of the browser settings.
*
*
* @return The ARN of the browser settings.
*/
public final String browserSettingsArn() {
return browserSettingsArn;
}
@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(hasAssociatedPortalArns() ? associatedPortalArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(browserPolicy());
hashCode = 31 * hashCode + Objects.hashCode(browserSettingsArn());
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 BrowserSettings)) {
return false;
}
BrowserSettings other = (BrowserSettings) obj;
return hasAssociatedPortalArns() == other.hasAssociatedPortalArns()
&& Objects.equals(associatedPortalArns(), other.associatedPortalArns())
&& Objects.equals(browserPolicy(), other.browserPolicy())
&& Objects.equals(browserSettingsArn(), other.browserSettingsArn());
}
/**
* 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("BrowserSettings")
.add("AssociatedPortalArns", hasAssociatedPortalArns() ? associatedPortalArns() : null)
.add("BrowserPolicy", browserPolicy()).add("BrowserSettingsArn", browserSettingsArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "associatedPortalArns":
return Optional.ofNullable(clazz.cast(associatedPortalArns()));
case "browserPolicy":
return Optional.ofNullable(clazz.cast(browserPolicy()));
case "browserSettingsArn":
return Optional.ofNullable(clazz.cast(browserSettingsArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BrowserSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of web portal ARNs that this browser settings is associated with.
*
*
* @param associatedPortalArns
* A list of web portal ARNs that this browser 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 browser settings is associated with.
*
*
* @param associatedPortalArns
* A list of web portal ARNs that this browser settings is associated with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder associatedPortalArns(String... associatedPortalArns);
/**
*
* A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
*
*
* @param browserPolicy
* A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder browserPolicy(String browserPolicy);
/**
*
* The ARN of the browser settings.
*
*
* @param browserSettingsArn
* The ARN of the browser settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder browserSettingsArn(String browserSettingsArn);
}
static final class BuilderImpl implements Builder {
private List associatedPortalArns = DefaultSdkAutoConstructList.getInstance();
private String browserPolicy;
private String browserSettingsArn;
private BuilderImpl() {
}
private BuilderImpl(BrowserSettings model) {
associatedPortalArns(model.associatedPortalArns);
browserPolicy(model.browserPolicy);
browserSettingsArn(model.browserSettingsArn);
}
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 String getBrowserPolicy() {
return browserPolicy;
}
public final void setBrowserPolicy(String browserPolicy) {
this.browserPolicy = browserPolicy;
}
@Override
public final Builder browserPolicy(String browserPolicy) {
this.browserPolicy = browserPolicy;
return this;
}
public final String getBrowserSettingsArn() {
return browserSettingsArn;
}
public final void setBrowserSettingsArn(String browserSettingsArn) {
this.browserSettingsArn = browserSettingsArn;
}
@Override
public final Builder browserSettingsArn(String browserSettingsArn) {
this.browserSettingsArn = browserSettingsArn;
return this;
}
@Override
public BrowserSettings build() {
return new BrowserSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy