software.amazon.awssdk.services.devicefarm.model.DeviceInstance Maven / Gradle / Ivy
Show all versions of devicefarm 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.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 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;
/**
*
* Represents the device instance.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeviceInstance implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(DeviceInstance::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField DEVICE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("deviceArn").getter(getter(DeviceInstance::deviceArn)).setter(setter(Builder::deviceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("deviceArn").build()).build();
private static final SdkField> LABELS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("labels")
.getter(getter(DeviceInstance::labels))
.setter(setter(Builder::labels))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("labels").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 SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(DeviceInstance::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final SdkField UDID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("udid")
.getter(getter(DeviceInstance::udid)).setter(setter(Builder::udid))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("udid").build()).build();
private static final SdkField INSTANCE_PROFILE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("instanceProfile")
.getter(getter(DeviceInstance::instanceProfile)).setter(setter(Builder::instanceProfile))
.constructor(InstanceProfile::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("instanceProfile").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, DEVICE_ARN_FIELD,
LABELS_FIELD, STATUS_FIELD, UDID_FIELD, INSTANCE_PROFILE_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final String deviceArn;
private final List labels;
private final String status;
private final String udid;
private final InstanceProfile instanceProfile;
private DeviceInstance(BuilderImpl builder) {
this.arn = builder.arn;
this.deviceArn = builder.deviceArn;
this.labels = builder.labels;
this.status = builder.status;
this.udid = builder.udid;
this.instanceProfile = builder.instanceProfile;
}
/**
*
* The Amazon Resource Name (ARN) of the device instance.
*
*
* @return The Amazon Resource Name (ARN) of the device instance.
*/
public final String arn() {
return arn;
}
/**
*
* The ARN of the device.
*
*
* @return The ARN of the device.
*/
public final String deviceArn() {
return deviceArn;
}
/**
* For responses, this returns true if the service returned a value for the Labels 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 hasLabels() {
return labels != null && !(labels instanceof SdkAutoConstructList);
}
/**
*
* An array of strings that describe the device instance.
*
*
* 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 #hasLabels} method.
*
*
* @return An array of strings that describe the device instance.
*/
public final List labels() {
return labels;
}
/**
*
* The status of the device instance. Valid values are listed here.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link InstanceStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the device instance. Valid values are listed here.
* @see InstanceStatus
*/
public final InstanceStatus status() {
return InstanceStatus.fromValue(status);
}
/**
*
* The status of the device instance. Valid values are listed here.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link InstanceStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the device instance. Valid values are listed here.
* @see InstanceStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* Unique device identifier for the device instance.
*
*
* @return Unique device identifier for the device instance.
*/
public final String udid() {
return udid;
}
/**
*
* A object that contains information about the instance profile.
*
*
* @return A object that contains information about the instance profile.
*/
public final InstanceProfile instanceProfile() {
return instanceProfile;
}
@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(arn());
hashCode = 31 * hashCode + Objects.hashCode(deviceArn());
hashCode = 31 * hashCode + Objects.hashCode(hasLabels() ? labels() : null);
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(udid());
hashCode = 31 * hashCode + Objects.hashCode(instanceProfile());
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 DeviceInstance)) {
return false;
}
DeviceInstance other = (DeviceInstance) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(deviceArn(), other.deviceArn())
&& hasLabels() == other.hasLabels() && Objects.equals(labels(), other.labels())
&& Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(udid(), other.udid())
&& Objects.equals(instanceProfile(), other.instanceProfile());
}
/**
* 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("DeviceInstance").add("Arn", arn()).add("DeviceArn", deviceArn())
.add("Labels", hasLabels() ? labels() : null).add("Status", statusAsString()).add("Udid", udid())
.add("InstanceProfile", instanceProfile()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "deviceArn":
return Optional.ofNullable(clazz.cast(deviceArn()));
case "labels":
return Optional.ofNullable(clazz.cast(labels()));
case "status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "udid":
return Optional.ofNullable(clazz.cast(udid()));
case "instanceProfile":
return Optional.ofNullable(clazz.cast(instanceProfile()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeviceInstance) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the device instance.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the device instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The ARN of the device.
*
*
* @param deviceArn
* The ARN of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceArn(String deviceArn);
/**
*
* An array of strings that describe the device instance.
*
*
* @param labels
* An array of strings that describe the device instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder labels(Collection labels);
/**
*
* An array of strings that describe the device instance.
*
*
* @param labels
* An array of strings that describe the device instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder labels(String... labels);
/**
*
* The status of the device instance. Valid values are listed here.
*
*
* @param status
* The status of the device instance. Valid values are listed here.
* @see InstanceStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceStatus
*/
Builder status(String status);
/**
*
* The status of the device instance. Valid values are listed here.
*
*
* @param status
* The status of the device instance. Valid values are listed here.
* @see InstanceStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceStatus
*/
Builder status(InstanceStatus status);
/**
*
* Unique device identifier for the device instance.
*
*
* @param udid
* Unique device identifier for the device instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder udid(String udid);
/**
*
* A object that contains information about the instance profile.
*
*
* @param instanceProfile
* A object that contains information about the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceProfile(InstanceProfile instanceProfile);
/**
*
* A object that contains information about the instance profile.
*
* This is a convenience method that creates an instance of the {@link InstanceProfile.Builder} avoiding the
* need to create one manually via {@link InstanceProfile#builder()}.
*
*
* When the {@link Consumer} completes, {@link InstanceProfile.Builder#build()} is called immediately and its
* result is passed to {@link #instanceProfile(InstanceProfile)}.
*
* @param instanceProfile
* a consumer that will call methods on {@link InstanceProfile.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #instanceProfile(InstanceProfile)
*/
default Builder instanceProfile(Consumer instanceProfile) {
return instanceProfile(InstanceProfile.builder().applyMutation(instanceProfile).build());
}
}
static final class BuilderImpl implements Builder {
private String arn;
private String deviceArn;
private List labels = DefaultSdkAutoConstructList.getInstance();
private String status;
private String udid;
private InstanceProfile instanceProfile;
private BuilderImpl() {
}
private BuilderImpl(DeviceInstance model) {
arn(model.arn);
deviceArn(model.deviceArn);
labels(model.labels);
status(model.status);
udid(model.udid);
instanceProfile(model.instanceProfile);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getDeviceArn() {
return deviceArn;
}
public final void setDeviceArn(String deviceArn) {
this.deviceArn = deviceArn;
}
@Override
public final Builder deviceArn(String deviceArn) {
this.deviceArn = deviceArn;
return this;
}
public final Collection getLabels() {
if (labels instanceof SdkAutoConstructList) {
return null;
}
return labels;
}
public final void setLabels(Collection labels) {
this.labels = InstanceLabelsCopier.copy(labels);
}
@Override
public final Builder labels(Collection labels) {
this.labels = InstanceLabelsCopier.copy(labels);
return this;
}
@Override
@SafeVarargs
public final Builder labels(String... labels) {
labels(Arrays.asList(labels));
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(InstanceStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getUdid() {
return udid;
}
public final void setUdid(String udid) {
this.udid = udid;
}
@Override
public final Builder udid(String udid) {
this.udid = udid;
return this;
}
public final InstanceProfile.Builder getInstanceProfile() {
return instanceProfile != null ? instanceProfile.toBuilder() : null;
}
public final void setInstanceProfile(InstanceProfile.BuilderImpl instanceProfile) {
this.instanceProfile = instanceProfile != null ? instanceProfile.build() : null;
}
@Override
public final Builder instanceProfile(InstanceProfile instanceProfile) {
this.instanceProfile = instanceProfile;
return this;
}
@Override
public DeviceInstance build() {
return new DeviceInstance(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}