software.amazon.awssdk.services.connect.model.UserSearchCriteria Maven / Gradle / Ivy
Show all versions of connect 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.connect.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 search criteria to be used to return users.
*
*
*
* The name and description fields support "contains" queries with a minimum of 2 characters
* and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UserSearchCriteria implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> OR_CONDITIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OrConditions")
.getter(getter(UserSearchCriteria::orConditions))
.setter(setter(Builder::orConditions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OrConditions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(UserSearchCriteria::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> AND_CONDITIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AndConditions")
.getter(getter(UserSearchCriteria::andConditions))
.setter(setter(Builder::andConditions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AndConditions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(UserSearchCriteria::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField STRING_CONDITION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("StringCondition")
.getter(getter(UserSearchCriteria::stringCondition)).setter(setter(Builder::stringCondition))
.constructor(StringCondition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StringCondition").build()).build();
private static final SdkField LIST_CONDITION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ListCondition")
.getter(getter(UserSearchCriteria::listCondition)).setter(setter(Builder::listCondition))
.constructor(ListCondition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ListCondition").build()).build();
private static final SdkField HIERARCHY_GROUP_CONDITION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("HierarchyGroupCondition")
.getter(getter(UserSearchCriteria::hierarchyGroupCondition)).setter(setter(Builder::hierarchyGroupCondition))
.constructor(HierarchyGroupCondition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HierarchyGroupCondition").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OR_CONDITIONS_FIELD,
AND_CONDITIONS_FIELD, STRING_CONDITION_FIELD, LIST_CONDITION_FIELD, HIERARCHY_GROUP_CONDITION_FIELD));
private static final long serialVersionUID = 1L;
private final List orConditions;
private final List andConditions;
private final StringCondition stringCondition;
private final ListCondition listCondition;
private final HierarchyGroupCondition hierarchyGroupCondition;
private UserSearchCriteria(BuilderImpl builder) {
this.orConditions = builder.orConditions;
this.andConditions = builder.andConditions;
this.stringCondition = builder.stringCondition;
this.listCondition = builder.listCondition;
this.hierarchyGroupCondition = builder.hierarchyGroupCondition;
}
/**
* For responses, this returns true if the service returned a value for the OrConditions 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 hasOrConditions() {
return orConditions != null && !(orConditions instanceof SdkAutoConstructList);
}
/**
*
* A list of conditions which would be applied together with an OR condition.
*
*
* 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 #hasOrConditions} method.
*
*
* @return A list of conditions which would be applied together with an OR condition.
*/
public final List orConditions() {
return orConditions;
}
/**
* For responses, this returns true if the service returned a value for the AndConditions 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 hasAndConditions() {
return andConditions != null && !(andConditions instanceof SdkAutoConstructList);
}
/**
*
* A list of conditions which would be applied together with an AND condition.
*
*
* 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 #hasAndConditions} method.
*
*
* @return A list of conditions which would be applied together with an AND condition.
*/
public final List andConditions() {
return andConditions;
}
/**
*
* A leaf node condition which can be used to specify a string condition.
*
*
* The currently supported values for FieldName are Username, FirstName,
* LastName, RoutingProfileId, SecurityProfileId, ResourceId.
*
*
* @return A leaf node condition which can be used to specify a string condition.
*
* The currently supported values for FieldName are Username,
* FirstName, LastName, RoutingProfileId,
* SecurityProfileId, ResourceId.
*/
public final StringCondition stringCondition() {
return stringCondition;
}
/**
*
* A leaf node condition which can be used to specify a List condition to search users with attributes included in
* Lists like Proficiencies.
*
*
* @return A leaf node condition which can be used to specify a List condition to search users with attributes
* included in Lists like Proficiencies.
*/
public final ListCondition listCondition() {
return listCondition;
}
/**
*
* A leaf node condition which can be used to specify a hierarchy group condition.
*
*
* @return A leaf node condition which can be used to specify a hierarchy group condition.
*/
public final HierarchyGroupCondition hierarchyGroupCondition() {
return hierarchyGroupCondition;
}
@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(hasOrConditions() ? orConditions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAndConditions() ? andConditions() : null);
hashCode = 31 * hashCode + Objects.hashCode(stringCondition());
hashCode = 31 * hashCode + Objects.hashCode(listCondition());
hashCode = 31 * hashCode + Objects.hashCode(hierarchyGroupCondition());
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 UserSearchCriteria)) {
return false;
}
UserSearchCriteria other = (UserSearchCriteria) obj;
return hasOrConditions() == other.hasOrConditions() && Objects.equals(orConditions(), other.orConditions())
&& hasAndConditions() == other.hasAndConditions() && Objects.equals(andConditions(), other.andConditions())
&& Objects.equals(stringCondition(), other.stringCondition())
&& Objects.equals(listCondition(), other.listCondition())
&& Objects.equals(hierarchyGroupCondition(), other.hierarchyGroupCondition());
}
/**
* 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("UserSearchCriteria").add("OrConditions", hasOrConditions() ? orConditions() : null)
.add("AndConditions", hasAndConditions() ? andConditions() : null).add("StringCondition", stringCondition())
.add("ListCondition", listCondition()).add("HierarchyGroupCondition", hierarchyGroupCondition()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OrConditions":
return Optional.ofNullable(clazz.cast(orConditions()));
case "AndConditions":
return Optional.ofNullable(clazz.cast(andConditions()));
case "StringCondition":
return Optional.ofNullable(clazz.cast(stringCondition()));
case "ListCondition":
return Optional.ofNullable(clazz.cast(listCondition()));
case "HierarchyGroupCondition":
return Optional.ofNullable(clazz.cast(hierarchyGroupCondition()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UserSearchCriteria) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of conditions which would be applied together with an OR condition.
*
*
* @param orConditions
* A list of conditions which would be applied together with an OR condition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder orConditions(Collection orConditions);
/**
*
* A list of conditions which would be applied together with an OR condition.
*
*
* @param orConditions
* A list of conditions which would be applied together with an OR condition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder orConditions(UserSearchCriteria... orConditions);
/**
*
* A list of conditions which would be applied together with an OR condition.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.UserSearchCriteria.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.connect.model.UserSearchCriteria#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.UserSearchCriteria.Builder#build()} is called
* immediately and its result is passed to {@link #orConditions(List)}.
*
* @param orConditions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.UserSearchCriteria.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #orConditions(java.util.Collection)
*/
Builder orConditions(Consumer... orConditions);
/**
*
* A list of conditions which would be applied together with an AND condition.
*
*
* @param andConditions
* A list of conditions which would be applied together with an AND condition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder andConditions(Collection andConditions);
/**
*
* A list of conditions which would be applied together with an AND condition.
*
*
* @param andConditions
* A list of conditions which would be applied together with an AND condition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder andConditions(UserSearchCriteria... andConditions);
/**
*
* A list of conditions which would be applied together with an AND condition.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.UserSearchCriteria.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.connect.model.UserSearchCriteria#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.UserSearchCriteria.Builder#build()} is called
* immediately and its result is passed to {@link #andConditions(List)}.
*
* @param andConditions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.UserSearchCriteria.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #andConditions(java.util.Collection)
*/
Builder andConditions(Consumer... andConditions);
/**
*
* A leaf node condition which can be used to specify a string condition.
*
*
* The currently supported values for FieldName are Username, FirstName,
* LastName, RoutingProfileId, SecurityProfileId, ResourceId
* .
*
*
* @param stringCondition
* A leaf node condition which can be used to specify a string condition.
*
* The currently supported values for FieldName are Username,
* FirstName, LastName, RoutingProfileId,
* SecurityProfileId, ResourceId.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stringCondition(StringCondition stringCondition);
/**
*
* A leaf node condition which can be used to specify a string condition.
*
*
* The currently supported values for FieldName are Username, FirstName,
* LastName, RoutingProfileId, SecurityProfileId, ResourceId
* .
*
* This is a convenience method that creates an instance of the {@link StringCondition.Builder} avoiding the
* need to create one manually via {@link StringCondition#builder()}.
*
*
* When the {@link Consumer} completes, {@link StringCondition.Builder#build()} is called immediately and its
* result is passed to {@link #stringCondition(StringCondition)}.
*
* @param stringCondition
* a consumer that will call methods on {@link StringCondition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #stringCondition(StringCondition)
*/
default Builder stringCondition(Consumer stringCondition) {
return stringCondition(StringCondition.builder().applyMutation(stringCondition).build());
}
/**
*
* A leaf node condition which can be used to specify a List condition to search users with attributes included
* in Lists like Proficiencies.
*
*
* @param listCondition
* A leaf node condition which can be used to specify a List condition to search users with attributes
* included in Lists like Proficiencies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder listCondition(ListCondition listCondition);
/**
*
* A leaf node condition which can be used to specify a List condition to search users with attributes included
* in Lists like Proficiencies.
*
* This is a convenience method that creates an instance of the {@link ListCondition.Builder} avoiding the need
* to create one manually via {@link ListCondition#builder()}.
*
*
* When the {@link Consumer} completes, {@link ListCondition.Builder#build()} is called immediately and its
* result is passed to {@link #listCondition(ListCondition)}.
*
* @param listCondition
* a consumer that will call methods on {@link ListCondition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #listCondition(ListCondition)
*/
default Builder listCondition(Consumer listCondition) {
return listCondition(ListCondition.builder().applyMutation(listCondition).build());
}
/**
*
* A leaf node condition which can be used to specify a hierarchy group condition.
*
*
* @param hierarchyGroupCondition
* A leaf node condition which can be used to specify a hierarchy group condition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hierarchyGroupCondition(HierarchyGroupCondition hierarchyGroupCondition);
/**
*
* A leaf node condition which can be used to specify a hierarchy group condition.
*
* This is a convenience method that creates an instance of the {@link HierarchyGroupCondition.Builder} avoiding
* the need to create one manually via {@link HierarchyGroupCondition#builder()}.
*
*
* When the {@link Consumer} completes, {@link HierarchyGroupCondition.Builder#build()} is called immediately
* and its result is passed to {@link #hierarchyGroupCondition(HierarchyGroupCondition)}.
*
* @param hierarchyGroupCondition
* a consumer that will call methods on {@link HierarchyGroupCondition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #hierarchyGroupCondition(HierarchyGroupCondition)
*/
default Builder hierarchyGroupCondition(Consumer hierarchyGroupCondition) {
return hierarchyGroupCondition(HierarchyGroupCondition.builder().applyMutation(hierarchyGroupCondition).build());
}
}
static final class BuilderImpl implements Builder {
private List orConditions = DefaultSdkAutoConstructList.getInstance();
private List andConditions = DefaultSdkAutoConstructList.getInstance();
private StringCondition stringCondition;
private ListCondition listCondition;
private HierarchyGroupCondition hierarchyGroupCondition;
private BuilderImpl() {
}
private BuilderImpl(UserSearchCriteria model) {
orConditions(model.orConditions);
andConditions(model.andConditions);
stringCondition(model.stringCondition);
listCondition(model.listCondition);
hierarchyGroupCondition(model.hierarchyGroupCondition);
}
public final List getOrConditions() {
List result = UserSearchConditionListCopier.copyToBuilder(this.orConditions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOrConditions(Collection orConditions) {
this.orConditions = UserSearchConditionListCopier.copyFromBuilder(orConditions);
}
@Override
public final Builder orConditions(Collection orConditions) {
this.orConditions = UserSearchConditionListCopier.copy(orConditions);
return this;
}
@Override
@SafeVarargs
public final Builder orConditions(UserSearchCriteria... orConditions) {
orConditions(Arrays.asList(orConditions));
return this;
}
@Override
@SafeVarargs
public final Builder orConditions(Consumer... orConditions) {
orConditions(Stream.of(orConditions).map(c -> UserSearchCriteria.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getAndConditions() {
List result = UserSearchConditionListCopier.copyToBuilder(this.andConditions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAndConditions(Collection andConditions) {
this.andConditions = UserSearchConditionListCopier.copyFromBuilder(andConditions);
}
@Override
public final Builder andConditions(Collection andConditions) {
this.andConditions = UserSearchConditionListCopier.copy(andConditions);
return this;
}
@Override
@SafeVarargs
public final Builder andConditions(UserSearchCriteria... andConditions) {
andConditions(Arrays.asList(andConditions));
return this;
}
@Override
@SafeVarargs
public final Builder andConditions(Consumer... andConditions) {
andConditions(Stream.of(andConditions).map(c -> UserSearchCriteria.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final StringCondition.Builder getStringCondition() {
return stringCondition != null ? stringCondition.toBuilder() : null;
}
public final void setStringCondition(StringCondition.BuilderImpl stringCondition) {
this.stringCondition = stringCondition != null ? stringCondition.build() : null;
}
@Override
public final Builder stringCondition(StringCondition stringCondition) {
this.stringCondition = stringCondition;
return this;
}
public final ListCondition.Builder getListCondition() {
return listCondition != null ? listCondition.toBuilder() : null;
}
public final void setListCondition(ListCondition.BuilderImpl listCondition) {
this.listCondition = listCondition != null ? listCondition.build() : null;
}
@Override
public final Builder listCondition(ListCondition listCondition) {
this.listCondition = listCondition;
return this;
}
public final HierarchyGroupCondition.Builder getHierarchyGroupCondition() {
return hierarchyGroupCondition != null ? hierarchyGroupCondition.toBuilder() : null;
}
public final void setHierarchyGroupCondition(HierarchyGroupCondition.BuilderImpl hierarchyGroupCondition) {
this.hierarchyGroupCondition = hierarchyGroupCondition != null ? hierarchyGroupCondition.build() : null;
}
@Override
public final Builder hierarchyGroupCondition(HierarchyGroupCondition hierarchyGroupCondition) {
this.hierarchyGroupCondition = hierarchyGroupCondition;
return this;
}
@Override
public UserSearchCriteria build() {
return new UserSearchCriteria(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}