software.amazon.awssdk.services.migrationhub.model.MigrationTaskSummary Maven / Gradle / Ivy
Show all versions of migrationhub Show documentation
/*
* Copyright 2015-2020 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.time.Instant;
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;
/**
*
* MigrationTaskSummary includes MigrationTaskName
, ProgressPercent
,
* ProgressUpdateStream
, Status
, and UpdateDateTime
for each task.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MigrationTaskSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField PROGRESS_UPDATE_STREAM_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(MigrationTaskSummary::progressUpdateStream)).setter(setter(Builder::progressUpdateStream))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProgressUpdateStream").build())
.build();
private static final SdkField MIGRATION_TASK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(MigrationTaskSummary::migrationTaskName)).setter(setter(Builder::migrationTaskName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MigrationTaskName").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(MigrationTaskSummary::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField PROGRESS_PERCENT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(MigrationTaskSummary::progressPercent)).setter(setter(Builder::progressPercent))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProgressPercent").build()).build();
private static final SdkField STATUS_DETAIL_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(MigrationTaskSummary::statusDetail)).setter(setter(Builder::statusDetail))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StatusDetail").build()).build();
private static final SdkField UPDATE_DATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(MigrationTaskSummary::updateDateTime)).setter(setter(Builder::updateDateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpdateDateTime").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PROGRESS_UPDATE_STREAM_FIELD,
MIGRATION_TASK_NAME_FIELD, STATUS_FIELD, PROGRESS_PERCENT_FIELD, STATUS_DETAIL_FIELD, UPDATE_DATE_TIME_FIELD));
private static final long serialVersionUID = 1L;
private final String progressUpdateStream;
private final String migrationTaskName;
private final String status;
private final Integer progressPercent;
private final String statusDetail;
private final Instant updateDateTime;
private MigrationTaskSummary(BuilderImpl builder) {
this.progressUpdateStream = builder.progressUpdateStream;
this.migrationTaskName = builder.migrationTaskName;
this.status = builder.status;
this.progressPercent = builder.progressPercent;
this.statusDetail = builder.statusDetail;
this.updateDateTime = builder.updateDateTime;
}
/**
*
* An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all
* updates made by the tool.
*
*
* @return An AWS resource used for access control. It should uniquely identify the migration tool as it is used for
* all updates made by the tool.
*/
public String progressUpdateStream() {
return progressUpdateStream;
}
/**
*
* Unique identifier that references the migration task. Do not store personal data in this field.
*
*
* @return Unique identifier that references the migration task. Do not store personal data in this field.
*/
public String migrationTaskName() {
return migrationTaskName;
}
/**
*
* Status of the task.
*
*
* 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.
* @see Status
*/
public Status status() {
return Status.fromValue(status);
}
/**
*
* Status of the task.
*
*
* 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.
* @see Status
*/
public String statusAsString() {
return status;
}
/**
*
* Indication of the percentage completion of the task.
*
*
* @return Indication of the percentage completion of the task.
*/
public Integer progressPercent() {
return progressPercent;
}
/**
*
* Detail information of what is being done within the overall status state.
*
*
* @return Detail information of what is being done within the overall status state.
*/
public String statusDetail() {
return statusDetail;
}
/**
*
* The timestamp when the task was gathered.
*
*
* @return The timestamp when the task was gathered.
*/
public Instant updateDateTime() {
return updateDateTime;
}
@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(progressUpdateStream());
hashCode = 31 * hashCode + Objects.hashCode(migrationTaskName());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(progressPercent());
hashCode = 31 * hashCode + Objects.hashCode(statusDetail());
hashCode = 31 * hashCode + Objects.hashCode(updateDateTime());
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 MigrationTaskSummary)) {
return false;
}
MigrationTaskSummary other = (MigrationTaskSummary) obj;
return Objects.equals(progressUpdateStream(), other.progressUpdateStream())
&& Objects.equals(migrationTaskName(), other.migrationTaskName())
&& Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(progressPercent(), other.progressPercent())
&& Objects.equals(statusDetail(), other.statusDetail())
&& Objects.equals(updateDateTime(), other.updateDateTime());
}
/**
* 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("MigrationTaskSummary").add("ProgressUpdateStream", progressUpdateStream())
.add("MigrationTaskName", migrationTaskName()).add("Status", statusAsString())
.add("ProgressPercent", progressPercent()).add("StatusDetail", statusDetail())
.add("UpdateDateTime", updateDateTime()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ProgressUpdateStream":
return Optional.ofNullable(clazz.cast(progressUpdateStream()));
case "MigrationTaskName":
return Optional.ofNullable(clazz.cast(migrationTaskName()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "ProgressPercent":
return Optional.ofNullable(clazz.cast(progressPercent()));
case "StatusDetail":
return Optional.ofNullable(clazz.cast(statusDetail()));
case "UpdateDateTime":
return Optional.ofNullable(clazz.cast(updateDateTime()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function