software.amazon.awssdk.services.migrationhub.model.MigrationTask 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.time.Instant;
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;
/**
*
* Represents a migration task in a migration tool.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MigrationTask implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField PROGRESS_UPDATE_STREAM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProgressUpdateStream").getter(getter(MigrationTask::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)
.memberName("MigrationTaskName").getter(getter(MigrationTask::migrationTaskName))
.setter(setter(Builder::migrationTaskName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MigrationTaskName").build()).build();
private static final SdkField TASK_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("Task")
.getter(getter(MigrationTask::task)).setter(setter(Builder::task)).constructor(Task::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Task").build()).build();
private static final SdkField UPDATE_DATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("UpdateDateTime").getter(getter(MigrationTask::updateDateTime)).setter(setter(Builder::updateDateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpdateDateTime").build()).build();
private static final SdkField> RESOURCE_ATTRIBUTE_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ResourceAttributeList")
.getter(getter(MigrationTask::resourceAttributeList))
.setter(setter(Builder::resourceAttributeList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceAttributeList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResourceAttribute::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PROGRESS_UPDATE_STREAM_FIELD,
MIGRATION_TASK_NAME_FIELD, TASK_FIELD, UPDATE_DATE_TIME_FIELD, RESOURCE_ATTRIBUTE_LIST_FIELD));
private static final long serialVersionUID = 1L;
private final String progressUpdateStream;
private final String migrationTaskName;
private final Task task;
private final Instant updateDateTime;
private final List resourceAttributeList;
private MigrationTask(BuilderImpl builder) {
this.progressUpdateStream = builder.progressUpdateStream;
this.migrationTaskName = builder.migrationTaskName;
this.task = builder.task;
this.updateDateTime = builder.updateDateTime;
this.resourceAttributeList = builder.resourceAttributeList;
}
/**
*
* A name that identifies the vendor of the migration tool being used.
*
*
* @return A name that identifies the vendor of the migration tool being used.
*/
public final 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 final String migrationTaskName() {
return migrationTaskName;
}
/**
*
* Task object encapsulating task information.
*
*
* @return Task object encapsulating task information.
*/
public final Task task() {
return task;
}
/**
*
* The timestamp when the task was gathered.
*
*
* @return The timestamp when the task was gathered.
*/
public final Instant updateDateTime() {
return updateDateTime;
}
/**
* For responses, this returns true if the service returned a value for the ResourceAttributeList 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 hasResourceAttributeList() {
return resourceAttributeList != null && !(resourceAttributeList instanceof SdkAutoConstructList);
}
/**
*
* Information about the resource that is being migrated. This data will be used to map the task to a resource in
* the Application Discovery Service repository.
*
*
* 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 #hasResourceAttributeList} method.
*
*
* @return Information about the resource that is being migrated. This data will be used to map the task to a
* resource in the Application Discovery Service repository.
*/
public final List resourceAttributeList() {
return resourceAttributeList;
}
@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(progressUpdateStream());
hashCode = 31 * hashCode + Objects.hashCode(migrationTaskName());
hashCode = 31 * hashCode + Objects.hashCode(task());
hashCode = 31 * hashCode + Objects.hashCode(updateDateTime());
hashCode = 31 * hashCode + Objects.hashCode(hasResourceAttributeList() ? resourceAttributeList() : null);
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 MigrationTask)) {
return false;
}
MigrationTask other = (MigrationTask) obj;
return Objects.equals(progressUpdateStream(), other.progressUpdateStream())
&& Objects.equals(migrationTaskName(), other.migrationTaskName()) && Objects.equals(task(), other.task())
&& Objects.equals(updateDateTime(), other.updateDateTime())
&& hasResourceAttributeList() == other.hasResourceAttributeList()
&& Objects.equals(resourceAttributeList(), other.resourceAttributeList());
}
/**
* 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("MigrationTask").add("ProgressUpdateStream", progressUpdateStream())
.add("MigrationTaskName", migrationTaskName()).add("Task", task()).add("UpdateDateTime", updateDateTime())
.add("ResourceAttributeList", hasResourceAttributeList() ? resourceAttributeList() : null).build();
}
public final 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 "Task":
return Optional.ofNullable(clazz.cast(task()));
case "UpdateDateTime":
return Optional.ofNullable(clazz.cast(updateDateTime()));
case "ResourceAttributeList":
return Optional.ofNullable(clazz.cast(resourceAttributeList()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MigrationTask) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A name that identifies the vendor of the migration tool being used.
*
*
* @param progressUpdateStream
* A name that identifies the vendor of the migration tool being used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder progressUpdateStream(String progressUpdateStream);
/**
*
* Unique identifier that references the migration task. Do not store personal data in this field.
*
*
* @param migrationTaskName
* Unique identifier that references the migration task. Do not store personal data in this field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder migrationTaskName(String migrationTaskName);
/**
*
* Task object encapsulating task information.
*
*
* @param task
* Task object encapsulating task information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder task(Task task);
/**
*
* Task object encapsulating task information.
*
* This is a convenience method that creates an instance of the {@link Task.Builder} avoiding the need to create
* one manually via {@link Task#builder()}.
*
*
* When the {@link Consumer} completes, {@link Task.Builder#build()} is called immediately and its result is
* passed to {@link #task(Task)}.
*
* @param task
* a consumer that will call methods on {@link Task.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #task(Task)
*/
default Builder task(Consumer task) {
return task(Task.builder().applyMutation(task).build());
}
/**
*
* The timestamp when the task was gathered.
*
*
* @param updateDateTime
* The timestamp when the task was gathered.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updateDateTime(Instant updateDateTime);
/**
*
* Information about the resource that is being migrated. This data will be used to map the task to a resource
* in the Application Discovery Service repository.
*
*
* @param resourceAttributeList
* Information about the resource that is being migrated. This data will be used to map the task to a
* resource in the Application Discovery Service repository.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceAttributeList(Collection resourceAttributeList);
/**
*
* Information about the resource that is being migrated. This data will be used to map the task to a resource
* in the Application Discovery Service repository.
*
*
* @param resourceAttributeList
* Information about the resource that is being migrated. This data will be used to map the task to a
* resource in the Application Discovery Service repository.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceAttributeList(ResourceAttribute... resourceAttributeList);
/**
*
* Information about the resource that is being migrated. This data will be used to map the task to a resource
* in the Application Discovery Service repository.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.migrationhub.model.ResourceAttribute.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.migrationhub.model.ResourceAttribute#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.migrationhub.model.ResourceAttribute.Builder#build()} is called
* immediately and its result is passed to {@link #resourceAttributeList(List)}.
*
* @param resourceAttributeList
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.migrationhub.model.ResourceAttribute.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #resourceAttributeList(java.util.Collection)
*/
Builder resourceAttributeList(Consumer... resourceAttributeList);
}
static final class BuilderImpl implements Builder {
private String progressUpdateStream;
private String migrationTaskName;
private Task task;
private Instant updateDateTime;
private List resourceAttributeList = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MigrationTask model) {
progressUpdateStream(model.progressUpdateStream);
migrationTaskName(model.migrationTaskName);
task(model.task);
updateDateTime(model.updateDateTime);
resourceAttributeList(model.resourceAttributeList);
}
public final String getProgressUpdateStream() {
return progressUpdateStream;
}
public final void setProgressUpdateStream(String progressUpdateStream) {
this.progressUpdateStream = progressUpdateStream;
}
@Override
public final Builder progressUpdateStream(String progressUpdateStream) {
this.progressUpdateStream = progressUpdateStream;
return this;
}
public final String getMigrationTaskName() {
return migrationTaskName;
}
public final void setMigrationTaskName(String migrationTaskName) {
this.migrationTaskName = migrationTaskName;
}
@Override
public final Builder migrationTaskName(String migrationTaskName) {
this.migrationTaskName = migrationTaskName;
return this;
}
public final Task.Builder getTask() {
return task != null ? task.toBuilder() : null;
}
public final void setTask(Task.BuilderImpl task) {
this.task = task != null ? task.build() : null;
}
@Override
public final Builder task(Task task) {
this.task = task;
return this;
}
public final Instant getUpdateDateTime() {
return updateDateTime;
}
public final void setUpdateDateTime(Instant updateDateTime) {
this.updateDateTime = updateDateTime;
}
@Override
public final Builder updateDateTime(Instant updateDateTime) {
this.updateDateTime = updateDateTime;
return this;
}
public final List getResourceAttributeList() {
List result = LatestResourceAttributeListCopier.copyToBuilder(this.resourceAttributeList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setResourceAttributeList(Collection resourceAttributeList) {
this.resourceAttributeList = LatestResourceAttributeListCopier.copyFromBuilder(resourceAttributeList);
}
@Override
public final Builder resourceAttributeList(Collection resourceAttributeList) {
this.resourceAttributeList = LatestResourceAttributeListCopier.copy(resourceAttributeList);
return this;
}
@Override
@SafeVarargs
public final Builder resourceAttributeList(ResourceAttribute... resourceAttributeList) {
resourceAttributeList(Arrays.asList(resourceAttributeList));
return this;
}
@Override
@SafeVarargs
public final Builder resourceAttributeList(Consumer... resourceAttributeList) {
resourceAttributeList(Stream.of(resourceAttributeList).map(c -> ResourceAttribute.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public MigrationTask build() {
return new MigrationTask(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}