software.amazon.awssdk.services.wisdom.model.GroupingConfiguration Maven / Gradle / Ivy
Show all versions of wisdom 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.wisdom.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
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.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 configuration information of the grouping of Wisdom users.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GroupingConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CRITERIA_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("criteria").getter(getter(GroupingConfiguration::criteria)).setter(setter(Builder::criteria))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("criteria").build()).build();
private static final SdkField> VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("values")
.getter(getter(GroupingConfiguration::values))
.setter(setter(Builder::values))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("values").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(CRITERIA_FIELD, VALUES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String criteria;
private final List values;
private GroupingConfiguration(BuilderImpl builder) {
this.criteria = builder.criteria;
this.values = builder.values;
}
/**
*
* The criteria used for grouping Wisdom users.
*
*
* The following is the list of supported criteria values.
*
*
* -
*
* RoutingProfileArn: Grouping the users by their Amazon Connect routing
* profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
*
*
*
*
* @return The criteria used for grouping Wisdom users.
*
* The following is the list of supported criteria values.
*
*
* -
*
* RoutingProfileArn: Grouping the users by their Amazon Connect
* routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
*
*
*/
public final String criteria() {
return criteria;
}
/**
* For responses, this returns true if the service returned a value for the Values 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 hasValues() {
return values != null && !(values instanceof SdkAutoConstructList);
}
/**
*
* The list of values that define different groups of Wisdom users.
*
*
* -
*
* When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing
* profiles as values of this parameter.
*
*
*
*
* 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 #hasValues} method.
*
*
* @return The list of values that define different groups of Wisdom users.
*
* -
*
* When setting criteria to RoutingProfileArn, you need to provide a list of ARNs
* of Amazon
* Connect routing profiles as values of this parameter.
*
*
*/
public final List values() {
return values;
}
@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(criteria());
hashCode = 31 * hashCode + Objects.hashCode(hasValues() ? values() : 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 GroupingConfiguration)) {
return false;
}
GroupingConfiguration other = (GroupingConfiguration) obj;
return Objects.equals(criteria(), other.criteria()) && hasValues() == other.hasValues()
&& Objects.equals(values(), other.values());
}
/**
* 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("GroupingConfiguration")
.add("Criteria", criteria() == null ? null : "*** Sensitive Data Redacted ***")
.add("Values", values() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "criteria":
return Optional.ofNullable(clazz.cast(criteria()));
case "values":
return Optional.ofNullable(clazz.cast(values()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("criteria", CRITERIA_FIELD);
map.put("values", VALUES_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((GroupingConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The criteria used for grouping Wisdom users.
*
*
* The following is the list of supported criteria values.
*
*
* -
*
* RoutingProfileArn: Grouping the users by their Amazon Connect routing
* profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
*
*
*
*
* @param criteria
* The criteria used for grouping Wisdom users.
*
* The following is the list of supported criteria values.
*
*
* -
*
* RoutingProfileArn: Grouping the users by their Amazon Connect
* routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder criteria(String criteria);
/**
*
* The list of values that define different groups of Wisdom users.
*
*
* -
*
* When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of
* Amazon Connect
* routing profiles as values of this parameter.
*
*
*
*
* @param values
* The list of values that define different groups of Wisdom users.
*
* -
*
* When setting criteria to RoutingProfileArn, you need to provide a list of
* ARNs of Amazon Connect
* routing profiles as values of this parameter.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Collection values);
/**
*
* The list of values that define different groups of Wisdom users.
*
*
* -
*
* When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of
* Amazon Connect
* routing profiles as values of this parameter.
*
*
*
*
* @param values
* The list of values that define different groups of Wisdom users.
*
* -
*
* When setting criteria to RoutingProfileArn, you need to provide a list of
* ARNs of Amazon Connect
* routing profiles as values of this parameter.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(String... values);
}
static final class BuilderImpl implements Builder {
private String criteria;
private List values = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GroupingConfiguration model) {
criteria(model.criteria);
values(model.values);
}
public final String getCriteria() {
return criteria;
}
public final void setCriteria(String criteria) {
this.criteria = criteria;
}
@Override
public final Builder criteria(String criteria) {
this.criteria = criteria;
return this;
}
public final Collection getValues() {
if (values instanceof SdkAutoConstructList) {
return null;
}
return values;
}
public final void setValues(Collection values) {
this.values = GroupingValuesCopier.copy(values);
}
@Override
public final Builder values(Collection values) {
this.values = GroupingValuesCopier.copy(values);
return this;
}
@Override
@SafeVarargs
public final Builder values(String... values) {
values(Arrays.asList(values));
return this;
}
@Override
public GroupingConfiguration build() {
return new GroupingConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}