software.amazon.awssdk.services.devicefarm.model.DeviceSelectionResult 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.devicefarm.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;
/**
*
* Contains the run results requested by the device selection configuration and how many devices were returned. For an
* example of the JSON response syntax, see ScheduleRun.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeviceSelectionResult implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("filters")
.getter(getter(DeviceSelectionResult::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(DeviceFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MATCHED_DEVICES_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("matchedDevicesCount").getter(getter(DeviceSelectionResult::matchedDevicesCount))
.setter(setter(Builder::matchedDevicesCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("matchedDevicesCount").build())
.build();
private static final SdkField MAX_DEVICES_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxDevices").getter(getter(DeviceSelectionResult::maxDevices)).setter(setter(Builder::maxDevices))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxDevices").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FILTERS_FIELD,
MATCHED_DEVICES_COUNT_FIELD, MAX_DEVICES_FIELD));
private static final long serialVersionUID = 1L;
private final List filters;
private final Integer matchedDevicesCount;
private final Integer maxDevices;
private DeviceSelectionResult(BuilderImpl builder) {
this.filters = builder.filters;
this.matchedDevicesCount = builder.matchedDevicesCount;
this.maxDevices = builder.maxDevices;
}
/**
* For responses, this returns true if the service returned a value for the Filters 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 hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* The filters in a device selection result.
*
*
* 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 #hasFilters} method.
*
*
* @return The filters in a device selection result.
*/
public final List filters() {
return filters;
}
/**
*
* The number of devices that matched the device filter selection criteria.
*
*
* @return The number of devices that matched the device filter selection criteria.
*/
public final Integer matchedDevicesCount() {
return matchedDevicesCount;
}
/**
*
* The maximum number of devices to be selected by a device filter and included in a test run.
*
*
* @return The maximum number of devices to be selected by a device filter and included in a test run.
*/
public final Integer maxDevices() {
return maxDevices;
}
@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(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(matchedDevicesCount());
hashCode = 31 * hashCode + Objects.hashCode(maxDevices());
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 DeviceSelectionResult)) {
return false;
}
DeviceSelectionResult other = (DeviceSelectionResult) obj;
return hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters())
&& Objects.equals(matchedDevicesCount(), other.matchedDevicesCount())
&& Objects.equals(maxDevices(), other.maxDevices());
}
/**
* 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("DeviceSelectionResult").add("Filters", hasFilters() ? filters() : null)
.add("MatchedDevicesCount", matchedDevicesCount()).add("MaxDevices", maxDevices()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "filters":
return Optional.ofNullable(clazz.cast(filters()));
case "matchedDevicesCount":
return Optional.ofNullable(clazz.cast(matchedDevicesCount()));
case "maxDevices":
return Optional.ofNullable(clazz.cast(maxDevices()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeviceSelectionResult) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The filters in a device selection result.
*
*
* @param filters
* The filters in a device selection result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* The filters in a device selection result.
*
*
* @param filters
* The filters in a device selection result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(DeviceFilter... filters);
/**
*
* The filters in a device selection result.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.devicefarm.model.DeviceFilter.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.devicefarm.model.DeviceFilter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.devicefarm.model.DeviceFilter.Builder#build()} is called immediately
* and its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.devicefarm.model.DeviceFilter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(java.util.Collection)
*/
Builder filters(Consumer... filters);
/**
*
* The number of devices that matched the device filter selection criteria.
*
*
* @param matchedDevicesCount
* The number of devices that matched the device filter selection criteria.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder matchedDevicesCount(Integer matchedDevicesCount);
/**
*
* The maximum number of devices to be selected by a device filter and included in a test run.
*
*
* @param maxDevices
* The maximum number of devices to be selected by a device filter and included in a test run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxDevices(Integer maxDevices);
}
static final class BuilderImpl implements Builder {
private List filters = DefaultSdkAutoConstructList.getInstance();
private Integer matchedDevicesCount;
private Integer maxDevices;
private BuilderImpl() {
}
private BuilderImpl(DeviceSelectionResult model) {
filters(model.filters);
matchedDevicesCount(model.matchedDevicesCount);
maxDevices(model.maxDevices);
}
public final List getFilters() {
List result = DeviceFiltersCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = DeviceFiltersCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = DeviceFiltersCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(DeviceFilter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> DeviceFilter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Integer getMatchedDevicesCount() {
return matchedDevicesCount;
}
public final void setMatchedDevicesCount(Integer matchedDevicesCount) {
this.matchedDevicesCount = matchedDevicesCount;
}
@Override
public final Builder matchedDevicesCount(Integer matchedDevicesCount) {
this.matchedDevicesCount = matchedDevicesCount;
return this;
}
public final Integer getMaxDevices() {
return maxDevices;
}
public final void setMaxDevices(Integer maxDevices) {
this.maxDevices = maxDevices;
}
@Override
public final Builder maxDevices(Integer maxDevices) {
this.maxDevices = maxDevices;
return this;
}
@Override
public DeviceSelectionResult build() {
return new DeviceSelectionResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}