com.amazonaws.services.codepipeline.model.StartPipelineExecutionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codepipeline Show documentation
/*
* Copyright 2019-2024 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.AmazonWebServiceRequest;
/**
*
* Represents the input of a StartPipelineExecution action.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartPipelineExecutionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the pipeline to start.
*
*/
private String name;
/**
*
* A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match
* [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
*
*/
private java.util.List variables;
/**
*
* The system-generated unique ID used to identify a unique execution request.
*
*/
private String clientRequestToken;
/**
*
* A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source artifact, for
* the pipeline execution.
*
*/
private java.util.List sourceRevisions;
/**
*
* The name of the pipeline to start.
*
*
* @param name
* The name of the pipeline to start.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the pipeline to start.
*
*
* @return The name of the pipeline to start.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the pipeline to start.
*
*
* @param name
* The name of the pipeline to start.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match
* [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
*
*
* @return A list that overrides pipeline variables for a pipeline execution that's being started. Variable names
* must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
*/
public java.util.List getVariables() {
return variables;
}
/**
*
* A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match
* [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
*
*
* @param variables
* A list that overrides pipeline variables for a pipeline execution that's being started. Variable names
* must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
*/
public void setVariables(java.util.Collection variables) {
if (variables == null) {
this.variables = null;
return;
}
this.variables = new java.util.ArrayList(variables);
}
/**
*
* A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match
* [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setVariables(java.util.Collection)} or {@link #withVariables(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param variables
* A list that overrides pipeline variables for a pipeline execution that's being started. Variable names
* must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withVariables(PipelineVariable... variables) {
if (this.variables == null) {
setVariables(new java.util.ArrayList(variables.length));
}
for (PipelineVariable ele : variables) {
this.variables.add(ele);
}
return this;
}
/**
*
* A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match
* [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
*
*
* @param variables
* A list that overrides pipeline variables for a pipeline execution that's being started. Variable names
* must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withVariables(java.util.Collection variables) {
setVariables(variables);
return this;
}
/**
*
* The system-generated unique ID used to identify a unique execution request.
*
*
* @param clientRequestToken
* The system-generated unique ID used to identify a unique execution request.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
*
* The system-generated unique ID used to identify a unique execution request.
*
*
* @return The system-generated unique ID used to identify a unique execution request.
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
*
* The system-generated unique ID used to identify a unique execution request.
*
*
* @param clientRequestToken
* The system-generated unique ID used to identify a unique execution request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
*
* A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source artifact, for
* the pipeline execution.
*
*
* @return A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source
* artifact, for the pipeline execution.
*/
public java.util.List getSourceRevisions() {
return sourceRevisions;
}
/**
*
* A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source artifact, for
* the pipeline execution.
*
*
* @param sourceRevisions
* A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source
* artifact, for the pipeline execution.
*/
public void setSourceRevisions(java.util.Collection sourceRevisions) {
if (sourceRevisions == null) {
this.sourceRevisions = null;
return;
}
this.sourceRevisions = new java.util.ArrayList(sourceRevisions);
}
/**
*
* A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source artifact, for
* the pipeline execution.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSourceRevisions(java.util.Collection)} or {@link #withSourceRevisions(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param sourceRevisions
* A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source
* artifact, for the pipeline execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withSourceRevisions(SourceRevisionOverride... sourceRevisions) {
if (this.sourceRevisions == null) {
setSourceRevisions(new java.util.ArrayList(sourceRevisions.length));
}
for (SourceRevisionOverride ele : sourceRevisions) {
this.sourceRevisions.add(ele);
}
return this;
}
/**
*
* A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source artifact, for
* the pipeline execution.
*
*
* @param sourceRevisions
* A list that allows you to specify, or override, the source revision for a pipeline execution that's being
* started. A source revision is the version with all the changes to your application code, or source
* artifact, for the pipeline execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withSourceRevisions(java.util.Collection sourceRevisions) {
setSourceRevisions(sourceRevisions);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getVariables() != null)
sb.append("Variables: ").append(getVariables()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getSourceRevisions() != null)
sb.append("SourceRevisions: ").append(getSourceRevisions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartPipelineExecutionRequest == false)
return false;
StartPipelineExecutionRequest other = (StartPipelineExecutionRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getVariables() == null ^ this.getVariables() == null)
return false;
if (other.getVariables() != null && other.getVariables().equals(this.getVariables()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getSourceRevisions() == null ^ this.getSourceRevisions() == null)
return false;
if (other.getSourceRevisions() != null && other.getSourceRevisions().equals(this.getSourceRevisions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getVariables() == null) ? 0 : getVariables().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getSourceRevisions() == null) ? 0 : getSourceRevisions().hashCode());
return hashCode;
}
@Override
public StartPipelineExecutionRequest clone() {
return (StartPipelineExecutionRequest) super.clone();
}
}