software.amazon.awssdk.services.connect.model.CreateSecurityProfileRequest Maven / Gradle / Ivy
/*
* 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.connect.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 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.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 CreateSecurityProfileRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField SECURITY_PROFILE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SecurityProfileName").getter(getter(CreateSecurityProfileRequest::securityProfileName))
.setter(setter(Builder::securityProfileName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecurityProfileName").build())
.build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateSecurityProfileRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> PERMISSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Permissions")
.getter(getter(CreateSecurityProfileRequest::permissions))
.setter(setter(Builder::permissions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Permissions").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 INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(CreateSecurityProfileRequest::instanceId))
.setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateSecurityProfileRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").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> ALLOWED_ACCESS_CONTROL_TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("AllowedAccessControlTags")
.getter(getter(CreateSecurityProfileRequest::allowedAccessControlTags))
.setter(setter(Builder::allowedAccessControlTags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllowedAccessControlTags").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> TAG_RESTRICTED_RESOURCES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TagRestrictedResources")
.getter(getter(CreateSecurityProfileRequest::tagRestrictedResources))
.setter(setter(Builder::tagRestrictedResources))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagRestrictedResources").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SECURITY_PROFILE_NAME_FIELD,
DESCRIPTION_FIELD, PERMISSIONS_FIELD, INSTANCE_ID_FIELD, TAGS_FIELD, ALLOWED_ACCESS_CONTROL_TAGS_FIELD,
TAG_RESTRICTED_RESOURCES_FIELD));
private final String securityProfileName;
private final String description;
private final List permissions;
private final String instanceId;
private final Map tags;
private final Map allowedAccessControlTags;
private final List tagRestrictedResources;
private CreateSecurityProfileRequest(BuilderImpl builder) {
super(builder);
this.securityProfileName = builder.securityProfileName;
this.description = builder.description;
this.permissions = builder.permissions;
this.instanceId = builder.instanceId;
this.tags = builder.tags;
this.allowedAccessControlTags = builder.allowedAccessControlTags;
this.tagRestrictedResources = builder.tagRestrictedResources;
}
/**
*
* The name of the security profile.
*
*
* @return The name of the security profile.
*/
public final String securityProfileName() {
return securityProfileName;
}
/**
*
* The description of the security profile.
*
*
* @return The description of the security profile.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the Permissions 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 hasPermissions() {
return permissions != null && !(permissions instanceof SdkAutoConstructList);
}
/**
*
* Permissions assigned to the security profile. For a list of valid permissions, see List of security profile
* permissions.
*
*
* 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 #hasPermissions} method.
*
*
* @return Permissions assigned to the security profile. For a list of valid permissions, see List of security
* profile permissions.
*/
public final List permissions() {
return permissions;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
* 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 SdkAutoConstructMap);
}
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
* "key2":"value2"} }.
*
*
* 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 used to organize, track, or control access for this resource. For example, { "tags":
* {"key1":"value1", "key2":"value2"} }.
*/
public final Map tags() {
return tags;
}
/**
* For responses, this returns true if the service returned a value for the AllowedAccessControlTags 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 hasAllowedAccessControlTags() {
return allowedAccessControlTags != null && !(allowedAccessControlTags instanceof SdkAutoConstructMap);
}
/**
*
* The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
*
*
* 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 #hasAllowedAccessControlTags} method.
*
*
* @return The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
*/
public final Map allowedAccessControlTags() {
return allowedAccessControlTags;
}
/**
* For responses, this returns true if the service returned a value for the TagRestrictedResources 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 hasTagRestrictedResources() {
return tagRestrictedResources != null && !(tagRestrictedResources instanceof SdkAutoConstructList);
}
/**
*
* The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are
* acceptable ResourceNames: User | SecurityProfile | Queue |
* RoutingProfile
*
*
* 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 #hasTagRestrictedResources} method.
*
*
* @return The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following
* are acceptable ResourceNames: User | SecurityProfile | Queue |
* RoutingProfile
*/
public final List tagRestrictedResources() {
return tagRestrictedResources;
}
@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(securityProfileName());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasPermissions() ? permissions() : null);
hashCode = 31 * hashCode + Objects.hashCode(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAllowedAccessControlTags() ? allowedAccessControlTags() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTagRestrictedResources() ? tagRestrictedResources() : 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 CreateSecurityProfileRequest)) {
return false;
}
CreateSecurityProfileRequest other = (CreateSecurityProfileRequest) obj;
return Objects.equals(securityProfileName(), other.securityProfileName())
&& Objects.equals(description(), other.description()) && hasPermissions() == other.hasPermissions()
&& Objects.equals(permissions(), other.permissions()) && Objects.equals(instanceId(), other.instanceId())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& hasAllowedAccessControlTags() == other.hasAllowedAccessControlTags()
&& Objects.equals(allowedAccessControlTags(), other.allowedAccessControlTags())
&& hasTagRestrictedResources() == other.hasTagRestrictedResources()
&& Objects.equals(tagRestrictedResources(), other.tagRestrictedResources());
}
/**
* 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("CreateSecurityProfileRequest").add("SecurityProfileName", securityProfileName())
.add("Description", description()).add("Permissions", hasPermissions() ? permissions() : null)
.add("InstanceId", instanceId()).add("Tags", hasTags() ? tags() : null)
.add("AllowedAccessControlTags", hasAllowedAccessControlTags() ? allowedAccessControlTags() : null)
.add("TagRestrictedResources", hasTagRestrictedResources() ? tagRestrictedResources() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SecurityProfileName":
return Optional.ofNullable(clazz.cast(securityProfileName()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Permissions":
return Optional.ofNullable(clazz.cast(permissions()));
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "AllowedAccessControlTags":
return Optional.ofNullable(clazz.cast(allowedAccessControlTags()));
case "TagRestrictedResources":
return Optional.ofNullable(clazz.cast(tagRestrictedResources()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateSecurityProfileRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the security profile.
*
*
* @param securityProfileName
* The name of the security profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder securityProfileName(String securityProfileName);
/**
*
* The description of the security profile.
*
*
* @param description
* The description of the security profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* Permissions assigned to the security profile. For a list of valid permissions, see List of security
* profile permissions.
*
*
* @param permissions
* Permissions assigned to the security profile. For a list of valid permissions, see List of
* security profile permissions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissions(Collection permissions);
/**
*
* Permissions assigned to the security profile. For a list of valid permissions, see List of security
* profile permissions.
*
*
* @param permissions
* Permissions assigned to the security profile. For a list of valid permissions, see List of
* security profile permissions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissions(String... permissions);
/**
*
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "tags":
* {"key1":"value1", "key2":"value2"} }.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource. For example, { "tags":
* {"key1":"value1", "key2":"value2"} }.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
*
*
* @param allowedAccessControlTags
* The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedAccessControlTags(Map allowedAccessControlTags);
/**
*
* The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are
* acceptable ResourceNames: User | SecurityProfile | Queue |
* RoutingProfile
*
*
* @param tagRestrictedResources
* The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following
* are acceptable ResourceNames: User | SecurityProfile | Queue |
* RoutingProfile
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagRestrictedResources(Collection tagRestrictedResources);
/**
*
* The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are
* acceptable ResourceNames: User | SecurityProfile | Queue |
* RoutingProfile
*
*
* @param tagRestrictedResources
* The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following
* are acceptable ResourceNames: User | SecurityProfile | Queue |
* RoutingProfile
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagRestrictedResources(String... tagRestrictedResources);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String securityProfileName;
private String description;
private List permissions = DefaultSdkAutoConstructList.getInstance();
private String instanceId;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private Map allowedAccessControlTags = DefaultSdkAutoConstructMap.getInstance();
private List tagRestrictedResources = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateSecurityProfileRequest model) {
super(model);
securityProfileName(model.securityProfileName);
description(model.description);
permissions(model.permissions);
instanceId(model.instanceId);
tags(model.tags);
allowedAccessControlTags(model.allowedAccessControlTags);
tagRestrictedResources(model.tagRestrictedResources);
}
public final String getSecurityProfileName() {
return securityProfileName;
}
public final void setSecurityProfileName(String securityProfileName) {
this.securityProfileName = securityProfileName;
}
@Override
public final Builder securityProfileName(String securityProfileName) {
this.securityProfileName = securityProfileName;
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 Collection getPermissions() {
if (permissions instanceof SdkAutoConstructList) {
return null;
}
return permissions;
}
public final void setPermissions(Collection permissions) {
this.permissions = PermissionsListCopier.copy(permissions);
}
@Override
public final Builder permissions(Collection permissions) {
this.permissions = PermissionsListCopier.copy(permissions);
return this;
}
@Override
@SafeVarargs
public final Builder permissions(String... permissions) {
permissions(Arrays.asList(permissions));
return this;
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
public final Map getAllowedAccessControlTags() {
if (allowedAccessControlTags instanceof SdkAutoConstructMap) {
return null;
}
return allowedAccessControlTags;
}
public final void setAllowedAccessControlTags(Map allowedAccessControlTags) {
this.allowedAccessControlTags = AllowedAccessControlTagsCopier.copy(allowedAccessControlTags);
}
@Override
public final Builder allowedAccessControlTags(Map allowedAccessControlTags) {
this.allowedAccessControlTags = AllowedAccessControlTagsCopier.copy(allowedAccessControlTags);
return this;
}
public final Collection getTagRestrictedResources() {
if (tagRestrictedResources instanceof SdkAutoConstructList) {
return null;
}
return tagRestrictedResources;
}
public final void setTagRestrictedResources(Collection tagRestrictedResources) {
this.tagRestrictedResources = TagRestrictedResourceListCopier.copy(tagRestrictedResources);
}
@Override
public final Builder tagRestrictedResources(Collection tagRestrictedResources) {
this.tagRestrictedResources = TagRestrictedResourceListCopier.copy(tagRestrictedResources);
return this;
}
@Override
@SafeVarargs
public final Builder tagRestrictedResources(String... tagRestrictedResources) {
tagRestrictedResources(Arrays.asList(tagRestrictedResources));
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 CreateSecurityProfileRequest build() {
return new CreateSecurityProfileRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy