software.amazon.awssdk.services.transfer.model.SendWorkflowStepStateRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transfer Show documentation
The AWS Java SDK for Transfer module holds the client classes that are used for communicating with Transfer.
The newest version!
/*
 * 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.transfer.model;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.awscore.AwsRequestOverrideConfiguration;
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;

/**
 */
@Generated("software.amazon.awssdk:codegen")
public final class SendWorkflowStepStateRequest extends TransferRequest implements
        ToCopyableBuilder {
    private static final SdkField WORKFLOW_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("WorkflowId").getter(getter(SendWorkflowStepStateRequest::workflowId))
            .setter(setter(Builder::workflowId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WorkflowId").build()).build();

    private static final SdkField EXECUTION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("ExecutionId").getter(getter(SendWorkflowStepStateRequest::executionId))
            .setter(setter(Builder::executionId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExecutionId").build()).build();

    private static final SdkField TOKEN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Token")
            .getter(getter(SendWorkflowStepStateRequest::token)).setter(setter(Builder::token))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Token").build()).build();

    private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
            .getter(getter(SendWorkflowStepStateRequest::statusAsString)).setter(setter(Builder::status))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(WORKFLOW_ID_FIELD,
            EXECUTION_ID_FIELD, TOKEN_FIELD, STATUS_FIELD));

    private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();

    private final String workflowId;

    private final String executionId;

    private final String token;

    private final String status;

    private SendWorkflowStepStateRequest(BuilderImpl builder) {
        super(builder);
        this.workflowId = builder.workflowId;
        this.executionId = builder.executionId;
        this.token = builder.token;
        this.status = builder.status;
    }

    /**
     * 
     * A unique identifier for the workflow.
     * 
     * 
     * @return A unique identifier for the workflow.
     */
    public final String workflowId() {
        return workflowId;
    }

    /**
     * 
     * A unique identifier for the execution of a workflow.
     * 
     * 
     * @return A unique identifier for the execution of a workflow.
     */
    public final String executionId() {
        return executionId;
    }

    /**
     * 
     * Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.
     * 
     * 
     * @return Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.
     */
    public final String token() {
        return token;
    }

    /**
     * 
     * Indicates whether the specified step succeeded or failed.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #status} will
     * return {@link CustomStepStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
     * {@link #statusAsString}.
     * 
     * 
     * @return Indicates whether the specified step succeeded or failed.
     * @see CustomStepStatus
     */
    public final CustomStepStatus status() {
        return CustomStepStatus.fromValue(status);
    }

    /**
     * 
     * Indicates whether the specified step succeeded or failed.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #status} will
     * return {@link CustomStepStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
     * {@link #statusAsString}.
     * 
     * 
     * @return Indicates whether the specified step succeeded or failed.
     * @see CustomStepStatus
     */
    public final String statusAsString() {
        return status;
    }

    @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 + super.hashCode();
        hashCode = 31 * hashCode + Objects.hashCode(workflowId());
        hashCode = 31 * hashCode + Objects.hashCode(executionId());
        hashCode = 31 * hashCode + Objects.hashCode(token());
        hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
        return hashCode;
    }

    @Override
    public final boolean equals(Object obj) {
        return super.equals(obj) && equalsBySdkFields(obj);
    }

    @Override
    public final boolean equalsBySdkFields(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof SendWorkflowStepStateRequest)) {
            return false;
        }
        SendWorkflowStepStateRequest other = (SendWorkflowStepStateRequest) obj;
        return Objects.equals(workflowId(), other.workflowId()) && Objects.equals(executionId(), other.executionId())
                && Objects.equals(token(), other.token()) && Objects.equals(statusAsString(), other.statusAsString());
    }

    /**
     * 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("SendWorkflowStepStateRequest").add("WorkflowId", workflowId()).add("ExecutionId", executionId())
                .add("Token", token()).add("Status", statusAsString()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "WorkflowId":
            return Optional.ofNullable(clazz.cast(workflowId()));
        case "ExecutionId":
            return Optional.ofNullable(clazz.cast(executionId()));
        case "Token":
            return Optional.ofNullable(clazz.cast(token()));
        case "Status":
            return Optional.ofNullable(clazz.cast(statusAsString()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    @Override
    public final Map> sdkFieldNameToField() {
        return SDK_NAME_TO_FIELD;
    }

    private static Map> memberNameToFieldInitializer() {
        Map> map = new HashMap<>();
        map.put("WorkflowId", WORKFLOW_ID_FIELD);
        map.put("ExecutionId", EXECUTION_ID_FIELD);
        map.put("Token", TOKEN_FIELD);
        map.put("Status", STATUS_FIELD);
        return Collections.unmodifiableMap(map);
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((SendWorkflowStepStateRequest) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * A unique identifier for the workflow.
         * 
         * 
         * @param workflowId
         *        A unique identifier for the workflow.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder workflowId(String workflowId);

        /**
         * 
         * A unique identifier for the execution of a workflow.
         * 
         * 
         * @param executionId
         *        A unique identifier for the execution of a workflow.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder executionId(String executionId);

        /**
         * 
         * Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.
         * 
         * 
         * @param token
         *        Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder token(String token);

        /**
         * 
         * Indicates whether the specified step succeeded or failed.
         * 
         * 
         * @param status
         *        Indicates whether the specified step succeeded or failed.
         * @see CustomStepStatus
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see CustomStepStatus
         */
        Builder status(String status);

        /**
         * 
         * Indicates whether the specified step succeeded or failed.
         * 
         * 
         * @param status
         *        Indicates whether the specified step succeeded or failed.
         * @see CustomStepStatus
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see CustomStepStatus
         */
        Builder status(CustomStepStatus status);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends TransferRequest.BuilderImpl implements Builder {
        private String workflowId;

        private String executionId;

        private String token;

        private String status;

        private BuilderImpl() {
        }

        private BuilderImpl(SendWorkflowStepStateRequest model) {
            super(model);
            workflowId(model.workflowId);
            executionId(model.executionId);
            token(model.token);
            status(model.status);
        }

        public final String getWorkflowId() {
            return workflowId;
        }

        public final void setWorkflowId(String workflowId) {
            this.workflowId = workflowId;
        }

        @Override
        public final Builder workflowId(String workflowId) {
            this.workflowId = workflowId;
            return this;
        }

        public final String getExecutionId() {
            return executionId;
        }

        public final void setExecutionId(String executionId) {
            this.executionId = executionId;
        }

        @Override
        public final Builder executionId(String executionId) {
            this.executionId = executionId;
            return this;
        }

        public final String getToken() {
            return token;
        }

        public final void setToken(String token) {
            this.token = token;
        }

        @Override
        public final Builder token(String token) {
            this.token = token;
            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(CustomStepStatus status) {
            this.status(status == null ? null : status.toString());
            return this;
        }

        @Override
        public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
            super.overrideConfiguration(overrideConfiguration);
            return this;
        }

        @Override
        public Builder overrideConfiguration(Consumer builderConsumer) {
            super.overrideConfiguration(builderConsumer);
            return this;
        }

        @Override
        public SendWorkflowStepStateRequest build() {
            return new SendWorkflowStepStateRequest(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }

        @Override
        public Map> sdkFieldNameToField() {
            return SDK_NAME_TO_FIELD;
        }
    }
}