software.amazon.awssdk.services.connect.model.SearchUsersRequest 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.util.Arrays;
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 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.LocationTrait;
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 SearchUsersRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(SearchUsersRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceId").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(SearchUsersRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(SearchUsersRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField SEARCH_FILTER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SearchFilter")
.getter(getter(SearchUsersRequest::searchFilter)).setter(setter(Builder::searchFilter))
.constructor(UserSearchFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SearchFilter").build()).build();
private static final SdkField SEARCH_CRITERIA_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SearchCriteria")
.getter(getter(SearchUsersRequest::searchCriteria)).setter(setter(Builder::searchCriteria))
.constructor(UserSearchCriteria::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SearchCriteria").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD, SEARCH_FILTER_FIELD, SEARCH_CRITERIA_FIELD));
private final String instanceId;
private final String nextToken;
private final Integer maxResults;
private final UserSearchFilter searchFilter;
private final UserSearchCriteria searchCriteria;
private SearchUsersRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.searchFilter = builder.searchFilter;
this.searchCriteria = builder.searchCriteria;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance.
*
*
*
* InstanceID is a required field. The "Required: No" below is incorrect.
*
*
*
* @return The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*
* InstanceID is a required field. The "Required: No" below is incorrect.
*
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* @return The token for the next set of results. Use the value returned in the previous response in the next
* request to retrieve the next set of results.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of results to return per page.
*
*
* @return The maximum number of results to return per page.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* Filters to be applied to search results.
*
*
* @return Filters to be applied to search results.
*/
public final UserSearchFilter searchFilter() {
return searchFilter;
}
/**
* Returns the value of the SearchCriteria property for this object.
*
* @return The value of the SearchCriteria property for this object.
*/
public final UserSearchCriteria searchCriteria() {
return searchCriteria;
}
@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(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(searchFilter());
hashCode = 31 * hashCode + Objects.hashCode(searchCriteria());
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 SearchUsersRequest)) {
return false;
}
SearchUsersRequest other = (SearchUsersRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(searchFilter(), other.searchFilter())
&& Objects.equals(searchCriteria(), other.searchCriteria());
}
/**
* 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("SearchUsersRequest").add("InstanceId", instanceId()).add("NextToken", nextToken())
.add("MaxResults", maxResults()).add("SearchFilter", searchFilter()).add("SearchCriteria", searchCriteria())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "SearchFilter":
return Optional.ofNullable(clazz.cast(searchFilter()));
case "SearchCriteria":
return Optional.ofNullable(clazz.cast(searchCriteria()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchUsersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance.
*
*
*
* InstanceID is a required field. The "Required: No" below is incorrect.
*
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*
* InstanceID is a required field. The "Required: No" below is incorrect.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* @param nextToken
* The token for the next set of results. Use the value returned in the previous response in the next
* request to retrieve the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of results to return per page.
*
*
* @param maxResults
* The maximum number of results to return per page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* Filters to be applied to search results.
*
*
* @param searchFilter
* Filters to be applied to search results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchFilter(UserSearchFilter searchFilter);
/**
*
* Filters to be applied to search results.
*
* This is a convenience method that creates an instance of the {@link UserSearchFilter.Builder} avoiding the
* need to create one manually via {@link UserSearchFilter#builder()}.
*
*
* When the {@link Consumer} completes, {@link UserSearchFilter.Builder#build()} is called immediately and its
* result is passed to {@link #searchFilter(UserSearchFilter)}.
*
* @param searchFilter
* a consumer that will call methods on {@link UserSearchFilter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #searchFilter(UserSearchFilter)
*/
default Builder searchFilter(Consumer searchFilter) {
return searchFilter(UserSearchFilter.builder().applyMutation(searchFilter).build());
}
/**
* Sets the value of the SearchCriteria property for this object.
*
* @param searchCriteria
* The new value for the SearchCriteria property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchCriteria(UserSearchCriteria searchCriteria);
/**
* Sets the value of the SearchCriteria property for this object.
*
* This is a convenience method that creates an instance of the {@link UserSearchCriteria.Builder} avoiding the
* need to create one manually via {@link UserSearchCriteria#builder()}.
*
*
* When the {@link Consumer} completes, {@link UserSearchCriteria.Builder#build()} is called immediately and its
* result is passed to {@link #searchCriteria(UserSearchCriteria)}.
*
* @param searchCriteria
* a consumer that will call methods on {@link UserSearchCriteria.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #searchCriteria(UserSearchCriteria)
*/
default Builder searchCriteria(Consumer searchCriteria) {
return searchCriteria(UserSearchCriteria.builder().applyMutation(searchCriteria).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private String nextToken;
private Integer maxResults;
private UserSearchFilter searchFilter;
private UserSearchCriteria searchCriteria;
private BuilderImpl() {
}
private BuilderImpl(SearchUsersRequest model) {
super(model);
instanceId(model.instanceId);
nextToken(model.nextToken);
maxResults(model.maxResults);
searchFilter(model.searchFilter);
searchCriteria(model.searchCriteria);
}
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 String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final UserSearchFilter.Builder getSearchFilter() {
return searchFilter != null ? searchFilter.toBuilder() : null;
}
public final void setSearchFilter(UserSearchFilter.BuilderImpl searchFilter) {
this.searchFilter = searchFilter != null ? searchFilter.build() : null;
}
@Override
public final Builder searchFilter(UserSearchFilter searchFilter) {
this.searchFilter = searchFilter;
return this;
}
public final UserSearchCriteria.Builder getSearchCriteria() {
return searchCriteria != null ? searchCriteria.toBuilder() : null;
}
public final void setSearchCriteria(UserSearchCriteria.BuilderImpl searchCriteria) {
this.searchCriteria = searchCriteria != null ? searchCriteria.build() : null;
}
@Override
public final Builder searchCriteria(UserSearchCriteria searchCriteria) {
this.searchCriteria = searchCriteria;
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 SearchUsersRequest build() {
return new SearchUsersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}