software.amazon.awssdk.services.workspacesweb.model.CreateIpAccessSettingsRequest 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.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 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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateIpAccessSettingsRequest extends WorkSpacesWebRequest implements
ToCopyableBuilder {
private static final SdkField> ADDITIONAL_ENCRYPTION_CONTEXT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("additionalEncryptionContext")
.getter(getter(CreateIpAccessSettingsRequest::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 CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreateIpAccessSettingsRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField CUSTOMER_MANAGED_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("customerManagedKey").getter(getter(CreateIpAccessSettingsRequest::customerManagedKey))
.setter(setter(Builder::customerManagedKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("customerManagedKey").build())
.build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateIpAccessSettingsRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("displayName").getter(getter(CreateIpAccessSettingsRequest::displayName))
.setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("displayName").build()).build();
private static final SdkField> IP_RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ipRules")
.getter(getter(CreateIpAccessSettingsRequest::ipRules))
.setter(setter(Builder::ipRules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ipRules").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(IpRule::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateIpAccessSettingsRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
ADDITIONAL_ENCRYPTION_CONTEXT_FIELD, CLIENT_TOKEN_FIELD, CUSTOMER_MANAGED_KEY_FIELD, DESCRIPTION_FIELD,
DISPLAY_NAME_FIELD, IP_RULES_FIELD, TAGS_FIELD));
private final Map additionalEncryptionContext;
private final String clientToken;
private final String customerManagedKey;
private final String description;
private final String displayName;
private final List ipRules;
private final List tags;
private CreateIpAccessSettingsRequest(BuilderImpl builder) {
super(builder);
this.additionalEncryptionContext = builder.additionalEncryptionContext;
this.clientToken = builder.clientToken;
this.customerManagedKey = builder.customerManagedKey;
this.description = builder.description;
this.displayName = builder.displayName;
this.ipRules = builder.ipRules;
this.tags = builder.tags;
}
/**
* 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);
}
/**
*
* Additional encryption context of the IP access 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 Additional encryption context of the IP access settings.
*/
public final Map additionalEncryptionContext() {
return additionalEncryptionContext;
}
/**
*
* 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 Amazon Web Services 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 Amazon Web Services SDK.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* The custom managed key of the IP access settings.
*
*
* @return The custom managed key of the IP access settings.
*/
public final String customerManagedKey() {
return customerManagedKey;
}
/**
*
* The description of the IP access settings.
*
*
* @return The description of the IP access settings.
*/
public final String description() {
return description;
}
/**
*
* The display name of the IP access settings.
*
*
* @return The display name of the IP access settings.
*/
public final String displayName() {
return displayName;
}
/**
* For responses, this returns true if the service returned a value for the IpRules 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 hasIpRules() {
return ipRules != null && !(ipRules instanceof SdkAutoConstructList);
}
/**
*
* The IP rules of the IP access 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 #hasIpRules} method.
*
*
* @return The IP rules of the IP access settings.
*/
public final List ipRules() {
return ipRules;
}
/**
* 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 IP access 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 IP access settings resource. A tag is a key-value pair.
*/
public final List tags() {
return tags;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasAdditionalEncryptionContext() ? additionalEncryptionContext() : null);
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(customerManagedKey());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(hasIpRules() ? ipRules() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreateIpAccessSettingsRequest)) {
return false;
}
CreateIpAccessSettingsRequest other = (CreateIpAccessSettingsRequest) obj;
return hasAdditionalEncryptionContext() == other.hasAdditionalEncryptionContext()
&& Objects.equals(additionalEncryptionContext(), other.additionalEncryptionContext())
&& Objects.equals(clientToken(), other.clientToken())
&& Objects.equals(customerManagedKey(), other.customerManagedKey())
&& Objects.equals(description(), other.description()) && Objects.equals(displayName(), other.displayName())
&& hasIpRules() == other.hasIpRules() && Objects.equals(ipRules(), other.ipRules())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("CreateIpAccessSettingsRequest")
.add("AdditionalEncryptionContext", hasAdditionalEncryptionContext() ? additionalEncryptionContext() : null)
.add("ClientToken", clientToken()).add("CustomerManagedKey", customerManagedKey())
.add("Description", description() == null ? null : "*** Sensitive Data Redacted ***")
.add("DisplayName", displayName() == null ? null : "*** Sensitive Data Redacted ***")
.add("IpRules", ipRules() == null ? null : "*** Sensitive Data Redacted ***")
.add("Tags", tags() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "additionalEncryptionContext":
return Optional.ofNullable(clazz.cast(additionalEncryptionContext()));
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "customerManagedKey":
return Optional.ofNullable(clazz.cast(customerManagedKey()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "displayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "ipRules":
return Optional.ofNullable(clazz.cast(ipRules()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateIpAccessSettingsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkSpacesWebRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Additional encryption context of the IP access settings.
*
*
* @param additionalEncryptionContext
* Additional encryption context of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder additionalEncryptionContext(Map additionalEncryptionContext);
/**
*
* 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 Amazon Web Services SDK.
*
*
* @param clientToken
* 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 Amazon Web Services SDK.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* The custom managed key of the IP access settings.
*
*
* @param customerManagedKey
* The custom managed key of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customerManagedKey(String customerManagedKey);
/**
*
* The description of the IP access settings.
*
*
* @param description
* The description of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The display name of the IP access settings.
*
*
* @param displayName
* The display name of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* The IP rules of the IP access settings.
*
*
* @param ipRules
* The IP rules of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ipRules(Collection ipRules);
/**
*
* The IP rules of the IP access settings.
*
*
* @param ipRules
* The IP rules of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ipRules(IpRule... ipRules);
/**
*
* The IP rules of the IP access settings.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workspacesweb.model.IpRule.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.workspacesweb.model.IpRule#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workspacesweb.model.IpRule.Builder#build()} is called immediately and
* its result is passed to {@link #ipRules(List)}.
*
* @param ipRules
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workspacesweb.model.IpRule.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #ipRules(java.util.Collection)
*/
Builder ipRules(Consumer... ipRules);
/**
*
* The tags to add to the IP access settings resource. A tag is a key-value pair.
*
*
* @param tags
* The tags to add to the IP access settings resource. A tag is a key-value pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* The tags to add to the IP access settings resource. A tag is a key-value pair.
*
*
* @param tags
* The tags to add to the IP access settings resource. A tag is a key-value pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* The tags to add to the IP access settings resource. A tag is a key-value pair.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workspacesweb.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.workspacesweb.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workspacesweb.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workspacesweb.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WorkSpacesWebRequest.BuilderImpl implements Builder {
private Map additionalEncryptionContext = DefaultSdkAutoConstructMap.getInstance();
private String clientToken;
private String customerManagedKey;
private String description;
private String displayName;
private List ipRules = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateIpAccessSettingsRequest model) {
super(model);
additionalEncryptionContext(model.additionalEncryptionContext);
clientToken(model.clientToken);
customerManagedKey(model.customerManagedKey);
description(model.description);
displayName(model.displayName);
ipRules(model.ipRules);
tags(model.tags);
}
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 String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
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 String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final List getIpRules() {
List result = IpRuleListCopier.copyToBuilder(this.ipRules);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setIpRules(Collection ipRules) {
this.ipRules = IpRuleListCopier.copyFromBuilder(ipRules);
}
@Override
public final Builder ipRules(Collection ipRules) {
this.ipRules = IpRuleListCopier.copy(ipRules);
return this;
}
@Override
@SafeVarargs
public final Builder ipRules(IpRule... ipRules) {
ipRules(Arrays.asList(ipRules));
return this;
}
@Override
@SafeVarargs
public final Builder ipRules(Consumer... ipRules) {
ipRules(Stream.of(ipRules).map(c -> IpRule.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateIpAccessSettingsRequest build() {
return new CreateIpAccessSettingsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}