software.amazon.awssdk.services.migrationhub.model.Task Maven / Gradle / Ivy
Show all versions of migrationhub 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.migrationhub.model;
import java.io.Serializable;
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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Task object encapsulating task information.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Task implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(Task::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField STATUS_DETAIL_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(Task::statusDetail)).setter(setter(Builder::statusDetail))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StatusDetail").build()).build();
private static final SdkField PROGRESS_PERCENT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(Task::progressPercent)).setter(setter(Builder::progressPercent))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProgressPercent").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATUS_FIELD,
STATUS_DETAIL_FIELD, PROGRESS_PERCENT_FIELD));
private static final long serialVersionUID = 1L;
private final String status;
private final String statusDetail;
private final Integer progressPercent;
private Task(BuilderImpl builder) {
this.status = builder.status;
this.statusDetail = builder.statusDetail;
this.progressPercent = builder.progressPercent;
}
/**
*
* Status of the task - Not Started, In-Progress, Complete.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link Status#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Status of the task - Not Started, In-Progress, Complete.
* @see Status
*/
public Status status() {
return Status.fromValue(status);
}
/**
*
* Status of the task - Not Started, In-Progress, Complete.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link Status#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Status of the task - Not Started, In-Progress, Complete.
* @see Status
*/
public String statusAsString() {
return status;
}
/**
*
* Details of task status as notified by a migration tool. A tool might use this field to provide clarifying
* information about the status that is unique to that tool or that explains an error state.
*
*
* @return Details of task status as notified by a migration tool. A tool might use this field to provide clarifying
* information about the status that is unique to that tool or that explains an error state.
*/
public String statusDetail() {
return statusDetail;
}
/**
*
* Indication of the percentage completion of the task.
*
*
* @return Indication of the percentage completion of the task.
*/
public Integer progressPercent() {
return progressPercent;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(statusDetail());
hashCode = 31 * hashCode + Objects.hashCode(progressPercent());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Task)) {
return false;
}
Task other = (Task) obj;
return Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(statusDetail(), other.statusDetail())
&& Objects.equals(progressPercent(), other.progressPercent());
}
/**
* 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 String toString() {
return ToString.builder("Task").add("Status", statusAsString()).add("StatusDetail", statusDetail())
.add("ProgressPercent", progressPercent()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "StatusDetail":
return Optional.ofNullable(clazz.cast(statusDetail()));
case "ProgressPercent":
return Optional.ofNullable(clazz.cast(progressPercent()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function