software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersResponse 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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class SearchAvailablePhoneNumbersResponse extends ConnectResponse implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(SearchAvailablePhoneNumbersResponse::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField> AVAILABLE_NUMBERS_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AvailableNumbersList")
.getter(getter(SearchAvailablePhoneNumbersResponse::availableNumbersList))
.setter(setter(Builder::availableNumbersList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AvailableNumbersList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AvailableNumberSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
AVAILABLE_NUMBERS_LIST_FIELD));
private final String nextToken;
private final List availableNumbersList;
private SearchAvailablePhoneNumbersResponse(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.availableNumbersList = builder.availableNumbersList;
}
/**
*
* If there are additional results, this is the token for the next set of results.
*
*
* @return If there are additional results, this is the token for the next set of results.
*/
public final String nextToken() {
return nextToken;
}
/**
* For responses, this returns true if the service returned a value for the AvailableNumbersList 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 hasAvailableNumbersList() {
return availableNumbersList != null && !(availableNumbersList instanceof SdkAutoConstructList);
}
/**
*
* A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
* group.
*
*
* 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 #hasAvailableNumbersList} method.
*
*
* @return A list of available phone numbers that you can claim to your Amazon Connect instance or traffic
* distribution group.
*/
public final List availableNumbersList() {
return availableNumbersList;
}
@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(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasAvailableNumbersList() ? availableNumbersList() : 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 SearchAvailablePhoneNumbersResponse)) {
return false;
}
SearchAvailablePhoneNumbersResponse other = (SearchAvailablePhoneNumbersResponse) obj;
return Objects.equals(nextToken(), other.nextToken()) && hasAvailableNumbersList() == other.hasAvailableNumbersList()
&& Objects.equals(availableNumbersList(), other.availableNumbersList());
}
/**
* 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("SearchAvailablePhoneNumbersResponse").add("NextToken", nextToken())
.add("AvailableNumbersList", hasAvailableNumbersList() ? availableNumbersList() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "AvailableNumbersList":
return Optional.ofNullable(clazz.cast(availableNumbersList()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchAvailablePhoneNumbersResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* If there are additional results, this is the token for the next set of results.
*
*
* @param nextToken
* If there are additional results, this is the token for the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
* group.
*
*
* @param availableNumbersList
* A list of available phone numbers that you can claim to your Amazon Connect instance or traffic
* distribution group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder availableNumbersList(Collection availableNumbersList);
/**
*
* A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
* group.
*
*
* @param availableNumbersList
* A list of available phone numbers that you can claim to your Amazon Connect instance or traffic
* distribution group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder availableNumbersList(AvailableNumberSummary... availableNumbersList);
/**
*
* A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution
* group.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.AvailableNumberSummary.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.connect.model.AvailableNumberSummary#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.AvailableNumberSummary.Builder#build()} is called
* immediately and its result is passed to {@link #availableNumbersList(List)}.
*
* @param availableNumbersList
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.AvailableNumberSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #availableNumbersList(java.util.Collection)
*/
Builder availableNumbersList(Consumer... availableNumbersList);
}
static final class BuilderImpl extends ConnectResponse.BuilderImpl implements Builder {
private String nextToken;
private List availableNumbersList = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SearchAvailablePhoneNumbersResponse model) {
super(model);
nextToken(model.nextToken);
availableNumbersList(model.availableNumbersList);
}
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 List getAvailableNumbersList() {
List result = AvailableNumbersListCopier.copyToBuilder(this.availableNumbersList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAvailableNumbersList(Collection availableNumbersList) {
this.availableNumbersList = AvailableNumbersListCopier.copyFromBuilder(availableNumbersList);
}
@Override
public final Builder availableNumbersList(Collection availableNumbersList) {
this.availableNumbersList = AvailableNumbersListCopier.copy(availableNumbersList);
return this;
}
@Override
@SafeVarargs
public final Builder availableNumbersList(AvailableNumberSummary... availableNumbersList) {
availableNumbersList(Arrays.asList(availableNumbersList));
return this;
}
@Override
@SafeVarargs
public final Builder availableNumbersList(Consumer... availableNumbersList) {
availableNumbersList(Stream.of(availableNumbersList)
.map(c -> AvailableNumberSummary.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public SearchAvailablePhoneNumbersResponse build() {
return new SearchAvailablePhoneNumbersResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}