com.amazonaws.services.datapipeline.model.SetStatusRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-datapipeline Show documentation
/*
 * Copyright 2010-2016 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 com.amazonaws.services.datapipeline.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 * Contains the parameters for SetStatus.
 * 
 */
public class SetStatusRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * The ID of the pipeline that contains the objects.
     * 
     */
    private String pipelineId;
    /**
     * 
     * The IDs of the objects. The corresponding objects can be either physical
     * or components, but not a mix of both types.
     * 
     */
    private com.amazonaws.internal.SdkInternalList objectIds;
    /**
     * 
     * The status to be set on all the objects specified in
     * objectIds. For components, use PAUSE or
     * RESUME. For instances, use TRY_CANCEL,
     * RERUN, or MARK_FINISHED.
     * 
     */
    private String status;
    /**
     * 
     * The ID of the pipeline that contains the objects.
     * 
     * 
     * @param pipelineId
     *        The ID of the pipeline that contains the objects.
     */
    public void setPipelineId(String pipelineId) {
        this.pipelineId = pipelineId;
    }
    /**
     * 
     * The ID of the pipeline that contains the objects.
     * 
     * 
     * @return The ID of the pipeline that contains the objects.
     */
    public String getPipelineId() {
        return this.pipelineId;
    }
    /**
     * 
     * The ID of the pipeline that contains the objects.
     * 
     * 
     * @param pipelineId
     *        The ID of the pipeline that contains the objects.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public SetStatusRequest withPipelineId(String pipelineId) {
        setPipelineId(pipelineId);
        return this;
    }
    /**
     * 
     * The IDs of the objects. The corresponding objects can be either physical
     * or components, but not a mix of both types.
     * 
     * 
     * @return The IDs of the objects. The corresponding objects can be either
     *         physical or components, but not a mix of both types.
     */
    public java.util.List getObjectIds() {
        if (objectIds == null) {
            objectIds = new com.amazonaws.internal.SdkInternalList();
        }
        return objectIds;
    }
    /**
     * 
     * The IDs of the objects. The corresponding objects can be either physical
     * or components, but not a mix of both types.
     * 
     * 
     * @param objectIds
     *        The IDs of the objects. The corresponding objects can be either
     *        physical or components, but not a mix of both types.
     */
    public void setObjectIds(java.util.Collection objectIds) {
        if (objectIds == null) {
            this.objectIds = null;
            return;
        }
        this.objectIds = new com.amazonaws.internal.SdkInternalList(
                objectIds);
    }
    /**
     * 
     * The IDs of the objects. The corresponding objects can be either physical
     * or components, but not a mix of both types.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setObjectIds(java.util.Collection)} or
     * {@link #withObjectIds(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param objectIds
     *        The IDs of the objects. The corresponding objects can be either
     *        physical or components, but not a mix of both types.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public SetStatusRequest withObjectIds(String... objectIds) {
        if (this.objectIds == null) {
            setObjectIds(new com.amazonaws.internal.SdkInternalList(
                    objectIds.length));
        }
        for (String ele : objectIds) {
            this.objectIds.add(ele);
        }
        return this;
    }
    /**
     * 
     * The IDs of the objects. The corresponding objects can be either physical
     * or components, but not a mix of both types.
     * 
     * 
     * @param objectIds
     *        The IDs of the objects. The corresponding objects can be either
     *        physical or components, but not a mix of both types.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public SetStatusRequest withObjectIds(java.util.Collection objectIds) {
        setObjectIds(objectIds);
        return this;
    }
    /**
     * 
     * The status to be set on all the objects specified in
     * objectIds. For components, use PAUSE or
     * RESUME. For instances, use TRY_CANCEL,
     * RERUN, or MARK_FINISHED.
     * 
     * 
     * @param status
     *        The status to be set on all the objects specified in
     *        objectIds. For components, use PAUSE or
     *        RESUME. For instances, use TRY_CANCEL,
     *        RERUN, or MARK_FINISHED.
     */
    public void setStatus(String status) {
        this.status = status;
    }
    /**
     * 
     * The status to be set on all the objects specified in
     * objectIds. For components, use PAUSE or
     * RESUME. For instances, use TRY_CANCEL,
     * RERUN, or MARK_FINISHED.
     * 
     * 
     * @return The status to be set on all the objects specified in
     *         objectIds. For components, use PAUSE or
     *         RESUME. For instances, use TRY_CANCEL,
     *         RERUN, or MARK_FINISHED.
     */
    public String getStatus() {
        return this.status;
    }
    /**
     * 
     * The status to be set on all the objects specified in
     * objectIds. For components, use PAUSE or
     * RESUME. For instances, use TRY_CANCEL,
     * RERUN, or MARK_FINISHED.
     * 
     * 
     * @param status
     *        The status to be set on all the objects specified in
     *        objectIds. For components, use PAUSE or
     *        RESUME. For instances, use TRY_CANCEL,
     *        RERUN, or MARK_FINISHED.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public SetStatusRequest withStatus(String status) {
        setStatus(status);
        return this;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getPipelineId() != null)
            sb.append("PipelineId: " + getPipelineId() + ",");
        if (getObjectIds() != null)
            sb.append("ObjectIds: " + getObjectIds() + ",");
        if (getStatus() != null)
            sb.append("Status: " + getStatus());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof SetStatusRequest == false)
            return false;
        SetStatusRequest other = (SetStatusRequest) obj;
        if (other.getPipelineId() == null ^ this.getPipelineId() == null)
            return false;
        if (other.getPipelineId() != null
                && other.getPipelineId().equals(this.getPipelineId()) == false)
            return false;
        if (other.getObjectIds() == null ^ this.getObjectIds() == null)
            return false;
        if (other.getObjectIds() != null
                && other.getObjectIds().equals(this.getObjectIds()) == false)
            return false;
        if (other.getStatus() == null ^ this.getStatus() == null)
            return false;
        if (other.getStatus() != null
                && other.getStatus().equals(this.getStatus()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getPipelineId() == null) ? 0 : getPipelineId().hashCode());
        hashCode = prime * hashCode
                + ((getObjectIds() == null) ? 0 : getObjectIds().hashCode());
        hashCode = prime * hashCode
                + ((getStatus() == null) ? 0 : getStatus().hashCode());
        return hashCode;
    }
    @Override
    public SetStatusRequest clone() {
        return (SetStatusRequest) super.clone();
    }
}