software.amazon.awssdk.services.workspaces.model.StreamingProperties Maven / Gradle / Ivy
Show all versions of workspaces 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.workspaces.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;
/**
*
* Describes the streaming properties.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StreamingProperties implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField STREAMING_EXPERIENCE_PREFERRED_PROTOCOL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("StreamingExperiencePreferredProtocol")
.getter(getter(StreamingProperties::streamingExperiencePreferredProtocolAsString))
.setter(setter(Builder::streamingExperiencePreferredProtocol))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("StreamingExperiencePreferredProtocol").build()).build();
private static final SdkField> USER_SETTINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("UserSettings")
.getter(getter(StreamingProperties::userSettings))
.setter(setter(Builder::userSettings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserSettings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(UserSetting::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> STORAGE_CONNECTORS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("StorageConnectors")
.getter(getter(StreamingProperties::storageConnectors))
.setter(setter(Builder::storageConnectors))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StorageConnectors").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(StorageConnector::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
STREAMING_EXPERIENCE_PREFERRED_PROTOCOL_FIELD, USER_SETTINGS_FIELD, STORAGE_CONNECTORS_FIELD));
private static final long serialVersionUID = 1L;
private final String streamingExperiencePreferredProtocol;
private final List userSettings;
private final List storageConnectors;
private StreamingProperties(BuilderImpl builder) {
this.streamingExperiencePreferredProtocol = builder.streamingExperiencePreferredProtocol;
this.userSettings = builder.userSettings;
this.storageConnectors = builder.storageConnectors;
}
/**
*
* Indicates the type of preferred protocol for the streaming experience.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #streamingExperiencePreferredProtocol} will return
* {@link StreamingExperiencePreferredProtocolEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #streamingExperiencePreferredProtocolAsString}.
*
*
* @return Indicates the type of preferred protocol for the streaming experience.
* @see StreamingExperiencePreferredProtocolEnum
*/
public final StreamingExperiencePreferredProtocolEnum streamingExperiencePreferredProtocol() {
return StreamingExperiencePreferredProtocolEnum.fromValue(streamingExperiencePreferredProtocol);
}
/**
*
* Indicates the type of preferred protocol for the streaming experience.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #streamingExperiencePreferredProtocol} will return
* {@link StreamingExperiencePreferredProtocolEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #streamingExperiencePreferredProtocolAsString}.
*
*
* @return Indicates the type of preferred protocol for the streaming experience.
* @see StreamingExperiencePreferredProtocolEnum
*/
public final String streamingExperiencePreferredProtocolAsString() {
return streamingExperiencePreferredProtocol;
}
/**
* For responses, this returns true if the service returned a value for the UserSettings 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 hasUserSettings() {
return userSettings != null && !(userSettings instanceof SdkAutoConstructList);
}
/**
*
* Indicates the permission settings asscoiated with the user.
*
*
* 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 #hasUserSettings} method.
*
*
* @return Indicates the permission settings asscoiated with the user.
*/
public final List userSettings() {
return userSettings;
}
/**
* For responses, this returns true if the service returned a value for the StorageConnectors 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 hasStorageConnectors() {
return storageConnectors != null && !(storageConnectors instanceof SdkAutoConstructList);
}
/**
*
* Indicates the storage connector used
*
*
* 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 #hasStorageConnectors} method.
*
*
* @return Indicates the storage connector used
*/
public final List storageConnectors() {
return storageConnectors;
}
@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(streamingExperiencePreferredProtocolAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasUserSettings() ? userSettings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasStorageConnectors() ? storageConnectors() : 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 StreamingProperties)) {
return false;
}
StreamingProperties other = (StreamingProperties) obj;
return Objects.equals(streamingExperiencePreferredProtocolAsString(),
other.streamingExperiencePreferredProtocolAsString())
&& hasUserSettings() == other.hasUserSettings()
&& Objects.equals(userSettings(), other.userSettings())
&& hasStorageConnectors() == other.hasStorageConnectors()
&& Objects.equals(storageConnectors(), other.storageConnectors());
}
/**
* 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("StreamingProperties")
.add("StreamingExperiencePreferredProtocol", streamingExperiencePreferredProtocolAsString())
.add("UserSettings", hasUserSettings() ? userSettings() : null)
.add("StorageConnectors", hasStorageConnectors() ? storageConnectors() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StreamingExperiencePreferredProtocol":
return Optional.ofNullable(clazz.cast(streamingExperiencePreferredProtocolAsString()));
case "UserSettings":
return Optional.ofNullable(clazz.cast(userSettings()));
case "StorageConnectors":
return Optional.ofNullable(clazz.cast(storageConnectors()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StreamingProperties) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Indicates the type of preferred protocol for the streaming experience.
*
*
* @param streamingExperiencePreferredProtocol
* Indicates the type of preferred protocol for the streaming experience.
* @see StreamingExperiencePreferredProtocolEnum
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamingExperiencePreferredProtocolEnum
*/
Builder streamingExperiencePreferredProtocol(String streamingExperiencePreferredProtocol);
/**
*
* Indicates the type of preferred protocol for the streaming experience.
*
*
* @param streamingExperiencePreferredProtocol
* Indicates the type of preferred protocol for the streaming experience.
* @see StreamingExperiencePreferredProtocolEnum
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamingExperiencePreferredProtocolEnum
*/
Builder streamingExperiencePreferredProtocol(StreamingExperiencePreferredProtocolEnum streamingExperiencePreferredProtocol);
/**
*
* Indicates the permission settings asscoiated with the user.
*
*
* @param userSettings
* Indicates the permission settings asscoiated with the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userSettings(Collection userSettings);
/**
*
* Indicates the permission settings asscoiated with the user.
*
*
* @param userSettings
* Indicates the permission settings asscoiated with the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userSettings(UserSetting... userSettings);
/**
*
* Indicates the permission settings asscoiated with the user.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workspaces.model.UserSetting.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.workspaces.model.UserSetting#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workspaces.model.UserSetting.Builder#build()} is called immediately
* and its result is passed to {@link #userSettings(List)}.
*
* @param userSettings
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workspaces.model.UserSetting.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #userSettings(java.util.Collection)
*/
Builder userSettings(Consumer... userSettings);
/**
*
* Indicates the storage connector used
*
*
* @param storageConnectors
* Indicates the storage connector used
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder storageConnectors(Collection storageConnectors);
/**
*
* Indicates the storage connector used
*
*
* @param storageConnectors
* Indicates the storage connector used
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder storageConnectors(StorageConnector... storageConnectors);
/**
*
* Indicates the storage connector used
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workspaces.model.StorageConnector.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.workspaces.model.StorageConnector#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workspaces.model.StorageConnector.Builder#build()} is called
* immediately and its result is passed to {@link #storageConnectors(List)}.
*
* @param storageConnectors
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workspaces.model.StorageConnector.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #storageConnectors(java.util.Collection)
*/
Builder storageConnectors(Consumer... storageConnectors);
}
static final class BuilderImpl implements Builder {
private String streamingExperiencePreferredProtocol;
private List userSettings = DefaultSdkAutoConstructList.getInstance();
private List storageConnectors = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(StreamingProperties model) {
streamingExperiencePreferredProtocol(model.streamingExperiencePreferredProtocol);
userSettings(model.userSettings);
storageConnectors(model.storageConnectors);
}
public final String getStreamingExperiencePreferredProtocol() {
return streamingExperiencePreferredProtocol;
}
public final void setStreamingExperiencePreferredProtocol(String streamingExperiencePreferredProtocol) {
this.streamingExperiencePreferredProtocol = streamingExperiencePreferredProtocol;
}
@Override
public final Builder streamingExperiencePreferredProtocol(String streamingExperiencePreferredProtocol) {
this.streamingExperiencePreferredProtocol = streamingExperiencePreferredProtocol;
return this;
}
@Override
public final Builder streamingExperiencePreferredProtocol(
StreamingExperiencePreferredProtocolEnum streamingExperiencePreferredProtocol) {
this.streamingExperiencePreferredProtocol(streamingExperiencePreferredProtocol == null ? null
: streamingExperiencePreferredProtocol.toString());
return this;
}
public final List getUserSettings() {
List result = UserSettingsCopier.copyToBuilder(this.userSettings);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setUserSettings(Collection userSettings) {
this.userSettings = UserSettingsCopier.copyFromBuilder(userSettings);
}
@Override
public final Builder userSettings(Collection userSettings) {
this.userSettings = UserSettingsCopier.copy(userSettings);
return this;
}
@Override
@SafeVarargs
public final Builder userSettings(UserSetting... userSettings) {
userSettings(Arrays.asList(userSettings));
return this;
}
@Override
@SafeVarargs
public final Builder userSettings(Consumer... userSettings) {
userSettings(Stream.of(userSettings).map(c -> UserSetting.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getStorageConnectors() {
List result = StorageConnectorsCopier.copyToBuilder(this.storageConnectors);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setStorageConnectors(Collection storageConnectors) {
this.storageConnectors = StorageConnectorsCopier.copyFromBuilder(storageConnectors);
}
@Override
public final Builder storageConnectors(Collection storageConnectors) {
this.storageConnectors = StorageConnectorsCopier.copy(storageConnectors);
return this;
}
@Override
@SafeVarargs
public final Builder storageConnectors(StorageConnector... storageConnectors) {
storageConnectors(Arrays.asList(storageConnectors));
return this;
}
@Override
@SafeVarargs
public final Builder storageConnectors(Consumer... storageConnectors) {
storageConnectors(Stream.of(storageConnectors).map(c -> StorageConnector.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public StreamingProperties build() {
return new StreamingProperties(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}