com.amazonaws.services.codepipeline.model.PipelineContext Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codepipeline Show documentation
/*
* Copyright 2016-2021 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.codepipeline.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Represents information about a pipeline to a job worker.
*
*
*
* PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The
* pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PipelineContext implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names
* under an Amazon Web Services account.
*
*/
private String pipelineName;
/**
*
* The stage of the pipeline.
*
*/
private StageContext stage;
/**
*
* The context of an action to a job worker in the stage of a pipeline.
*
*/
private ActionContext action;
/**
*
* The Amazon Resource Name (ARN) of the pipeline.
*
*/
private String pipelineArn;
/**
*
* The execution ID of the pipeline.
*
*/
private String pipelineExecutionId;
/**
*
* The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names
* under an Amazon Web Services account.
*
*
* @param pipelineName
* The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all
* pipeline names under an Amazon Web Services account.
*/
public void setPipelineName(String pipelineName) {
this.pipelineName = pipelineName;
}
/**
*
* The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names
* under an Amazon Web Services account.
*
*
* @return The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all
* pipeline names under an Amazon Web Services account.
*/
public String getPipelineName() {
return this.pipelineName;
}
/**
*
* The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names
* under an Amazon Web Services account.
*
*
* @param pipelineName
* The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all
* pipeline names under an Amazon Web Services account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipelineContext withPipelineName(String pipelineName) {
setPipelineName(pipelineName);
return this;
}
/**
*
* The stage of the pipeline.
*
*
* @param stage
* The stage of the pipeline.
*/
public void setStage(StageContext stage) {
this.stage = stage;
}
/**
*
* The stage of the pipeline.
*
*
* @return The stage of the pipeline.
*/
public StageContext getStage() {
return this.stage;
}
/**
*
* The stage of the pipeline.
*
*
* @param stage
* The stage of the pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipelineContext withStage(StageContext stage) {
setStage(stage);
return this;
}
/**
*
* The context of an action to a job worker in the stage of a pipeline.
*
*
* @param action
* The context of an action to a job worker in the stage of a pipeline.
*/
public void setAction(ActionContext action) {
this.action = action;
}
/**
*
* The context of an action to a job worker in the stage of a pipeline.
*
*
* @return The context of an action to a job worker in the stage of a pipeline.
*/
public ActionContext getAction() {
return this.action;
}
/**
*
* The context of an action to a job worker in the stage of a pipeline.
*
*
* @param action
* The context of an action to a job worker in the stage of a pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipelineContext withAction(ActionContext action) {
setAction(action);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the pipeline.
*
*
* @param pipelineArn
* The Amazon Resource Name (ARN) of the pipeline.
*/
public void setPipelineArn(String pipelineArn) {
this.pipelineArn = pipelineArn;
}
/**
*
* The Amazon Resource Name (ARN) of the pipeline.
*
*
* @return The Amazon Resource Name (ARN) of the pipeline.
*/
public String getPipelineArn() {
return this.pipelineArn;
}
/**
*
* The Amazon Resource Name (ARN) of the pipeline.
*
*
* @param pipelineArn
* The Amazon Resource Name (ARN) of the pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipelineContext withPipelineArn(String pipelineArn) {
setPipelineArn(pipelineArn);
return this;
}
/**
*
* The execution ID of the pipeline.
*
*
* @param pipelineExecutionId
* The execution ID of the pipeline.
*/
public void setPipelineExecutionId(String pipelineExecutionId) {
this.pipelineExecutionId = pipelineExecutionId;
}
/**
*
* The execution ID of the pipeline.
*
*
* @return The execution ID of the pipeline.
*/
public String getPipelineExecutionId() {
return this.pipelineExecutionId;
}
/**
*
* The execution ID of the pipeline.
*
*
* @param pipelineExecutionId
* The execution ID of the pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipelineContext withPipelineExecutionId(String pipelineExecutionId) {
setPipelineExecutionId(pipelineExecutionId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPipelineName() != null)
sb.append("PipelineName: ").append(getPipelineName()).append(",");
if (getStage() != null)
sb.append("Stage: ").append(getStage()).append(",");
if (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getPipelineArn() != null)
sb.append("PipelineArn: ").append(getPipelineArn()).append(",");
if (getPipelineExecutionId() != null)
sb.append("PipelineExecutionId: ").append(getPipelineExecutionId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PipelineContext == false)
return false;
PipelineContext other = (PipelineContext) obj;
if (other.getPipelineName() == null ^ this.getPipelineName() == null)
return false;
if (other.getPipelineName() != null && other.getPipelineName().equals(this.getPipelineName()) == false)
return false;
if (other.getStage() == null ^ this.getStage() == null)
return false;
if (other.getStage() != null && other.getStage().equals(this.getStage()) == false)
return false;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
if (other.getPipelineArn() == null ^ this.getPipelineArn() == null)
return false;
if (other.getPipelineArn() != null && other.getPipelineArn().equals(this.getPipelineArn()) == false)
return false;
if (other.getPipelineExecutionId() == null ^ this.getPipelineExecutionId() == null)
return false;
if (other.getPipelineExecutionId() != null && other.getPipelineExecutionId().equals(this.getPipelineExecutionId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPipelineName() == null) ? 0 : getPipelineName().hashCode());
hashCode = prime * hashCode + ((getStage() == null) ? 0 : getStage().hashCode());
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getPipelineArn() == null) ? 0 : getPipelineArn().hashCode());
hashCode = prime * hashCode + ((getPipelineExecutionId() == null) ? 0 : getPipelineExecutionId().hashCode());
return hashCode;
}
@Override
public PipelineContext clone() {
try {
return (PipelineContext) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.codepipeline.model.transform.PipelineContextMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}