software.amazon.awssdk.services.alexaforbusiness.model.SearchContactsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of alexaforbusiness Show documentation
Show all versions of alexaforbusiness Show documentation
The AWS Java SDK for Alexa For Business module holds the client classes that are used for communicating
with Alexa For Business Service
/*
* 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.alexaforbusiness.model;
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.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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class SearchContactsRequest extends AlexaForBusinessRequest implements
ToCopyableBuilder {
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(SearchContactsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SORT_CRITERIA_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SortCriteria")
.getter(getter(SearchContactsRequest::sortCriteria))
.setter(setter(Builder::sortCriteria))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortCriteria").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Sort::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(SearchContactsRequest::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(SearchContactsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FILTERS_FIELD,
SORT_CRITERIA_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final List filters;
private final List sortCriteria;
private final String nextToken;
private final Integer maxResults;
private SearchContactsRequest(BuilderImpl builder) {
super(builder);
this.filters = builder.filters;
this.sortCriteria = builder.sortCriteria;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
* Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* The filters to use to list a specified set of address books. The supported filter keys are DisplayName,
* FirstName, LastName, and AddressBookArns.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasFilters()} to see if a value was sent in this field.
*
*
* @return The filters to use to list a specified set of address books. The supported filter keys are DisplayName,
* FirstName, LastName, and AddressBookArns.
*/
public final List filters() {
return filters;
}
/**
* Returns true if the SortCriteria property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasSortCriteria() {
return sortCriteria != null && !(sortCriteria instanceof SdkAutoConstructList);
}
/**
*
* The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName,
* FirstName, and LastName.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasSortCriteria()} to see if a value was sent in this field.
*
*
* @return The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName,
* FirstName, and LastName.
*/
public final List sortCriteria() {
return sortCriteria;
}
/**
*
* An optional token returned from a prior request. Use this token for pagination of results from this action. If
* this parameter is specified, the response only includes results beyond the token, up to the value specified by
* MaxResults.
*
*
* @return An optional token returned from a prior request. Use this token for pagination of results from this
* action. If this parameter is specified, the response only includes results beyond the token, up to the
* value specified by MaxResults.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of results to include in the response. If more results exist than the specified MaxResults
* value, a token is included in the response so that the remaining results can be retrieved.
*
*
* @return The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
public final Integer maxResults() {
return maxResults;
}
@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(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSortCriteria() ? sortCriteria() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 SearchContactsRequest)) {
return false;
}
SearchContactsRequest other = (SearchContactsRequest) obj;
return hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters())
&& hasSortCriteria() == other.hasSortCriteria() && Objects.equals(sortCriteria(), other.sortCriteria())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("SearchContactsRequest").add("Filters", hasFilters() ? filters() : null)
.add("SortCriteria", hasSortCriteria() ? sortCriteria() : null).add("NextToken", nextToken())
.add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "SortCriteria":
return Optional.ofNullable(clazz.cast(sortCriteria()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchContactsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AlexaForBusinessRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The filters to use to list a specified set of address books. The supported filter keys are DisplayName,
* FirstName, LastName, and AddressBookArns.
*
*
* @param filters
* The filters to use to list a specified set of address books. The supported filter keys are
* DisplayName, FirstName, LastName, and AddressBookArns.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* The filters to use to list a specified set of address books. The supported filter keys are DisplayName,
* FirstName, LastName, and AddressBookArns.
*
*
* @param filters
* The filters to use to list a specified set of address books. The supported filter keys are
* DisplayName, FirstName, LastName, and AddressBookArns.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* The filters to use to list a specified set of address books. The supported filter keys are DisplayName,
* FirstName, LastName, and AddressBookArns.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(List)
*/
Builder filters(Consumer... filters);
/**
*
* The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName,
* FirstName, and LastName.
*
*
* @param sortCriteria
* The sort order to use in listing the specified set of contacts. The supported sort keys are
* DisplayName, FirstName, and LastName.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sortCriteria(Collection sortCriteria);
/**
*
* The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName,
* FirstName, and LastName.
*
*
* @param sortCriteria
* The sort order to use in listing the specified set of contacts. The supported sort keys are
* DisplayName, FirstName, and LastName.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sortCriteria(Sort... sortCriteria);
/**
*
* The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName,
* FirstName, and LastName.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #sortCriteria(List)}.
*
* @param sortCriteria
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #sortCriteria(List)
*/
Builder sortCriteria(Consumer... sortCriteria);
/**
*
* An optional token returned from a prior request. Use this token for pagination of results from this action.
* If this parameter is specified, the response only includes results beyond the token, up to the value
* specified by MaxResults.
*
*
* @param nextToken
* An optional token returned from a prior request. Use this token for pagination of results from this
* action. If this parameter is specified, the response only includes results beyond the token, up to the
* value specified by MaxResults.
* @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 include in the response. If more results exist than the specified MaxResults
* value, a token is included in the response so that the remaining results can be retrieved.
*
*
* @param maxResults
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AlexaForBusinessRequest.BuilderImpl implements Builder {
private List filters = DefaultSdkAutoConstructList.getInstance();
private List sortCriteria = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(SearchContactsRequest model) {
super(model);
filters(model.filters);
sortCriteria(model.sortCriteria);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final Collection getFilters() {
if (filters instanceof SdkAutoConstructList) {
return null;
}
return filters != null ? filters.stream().map(Filter::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
public final Collection getSortCriteria() {
if (sortCriteria instanceof SdkAutoConstructList) {
return null;
}
return sortCriteria != null ? sortCriteria.stream().map(Sort::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder sortCriteria(Collection sortCriteria) {
this.sortCriteria = SortListCopier.copy(sortCriteria);
return this;
}
@Override
@SafeVarargs
public final Builder sortCriteria(Sort... sortCriteria) {
sortCriteria(Arrays.asList(sortCriteria));
return this;
}
@Override
@SafeVarargs
public final Builder sortCriteria(Consumer... sortCriteria) {
sortCriteria(Stream.of(sortCriteria).map(c -> Sort.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setSortCriteria(Collection sortCriteria) {
this.sortCriteria = SortListCopier.copyFromBuilder(sortCriteria);
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SearchContactsRequest build() {
return new SearchContactsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy