
com.amazonaws.services.sagemaker.model.StartPipelineExecutionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartPipelineExecutionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or Amazon Resource Name (ARN) of the pipeline.
*
*/
private String pipelineName;
/**
*
* The display name of the pipeline execution.
*
*/
private String pipelineExecutionDisplayName;
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
*/
private java.util.List pipelineParameters;
/**
*
* The description of the pipeline execution.
*
*/
private String pipelineExecutionDescription;
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
* operation completes no more than once.
*
*/
private String clientRequestToken;
/**
*
* This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this
* specific run.
*
*/
private ParallelismConfiguration parallelismConfiguration;
/**
*
* The selective execution configuration applied to the pipeline run.
*
*/
private SelectiveExecutionConfig selectiveExecutionConfig;
/**
*
* The name or Amazon Resource Name (ARN) of the pipeline.
*
*
* @param pipelineName
* The name or Amazon Resource Name (ARN) of the pipeline.
*/
public void setPipelineName(String pipelineName) {
this.pipelineName = pipelineName;
}
/**
*
* The name or Amazon Resource Name (ARN) of the pipeline.
*
*
* @return The name or Amazon Resource Name (ARN) of the pipeline.
*/
public String getPipelineName() {
return this.pipelineName;
}
/**
*
* The name or Amazon Resource Name (ARN) of the pipeline.
*
*
* @param pipelineName
* The name or Amazon Resource Name (ARN) of the pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withPipelineName(String pipelineName) {
setPipelineName(pipelineName);
return this;
}
/**
*
* The display name of the pipeline execution.
*
*
* @param pipelineExecutionDisplayName
* The display name of the pipeline execution.
*/
public void setPipelineExecutionDisplayName(String pipelineExecutionDisplayName) {
this.pipelineExecutionDisplayName = pipelineExecutionDisplayName;
}
/**
*
* The display name of the pipeline execution.
*
*
* @return The display name of the pipeline execution.
*/
public String getPipelineExecutionDisplayName() {
return this.pipelineExecutionDisplayName;
}
/**
*
* The display name of the pipeline execution.
*
*
* @param pipelineExecutionDisplayName
* The display name of the pipeline execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withPipelineExecutionDisplayName(String pipelineExecutionDisplayName) {
setPipelineExecutionDisplayName(pipelineExecutionDisplayName);
return this;
}
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
*
* @return Contains a list of pipeline parameters. This list can be empty.
*/
public java.util.List getPipelineParameters() {
return pipelineParameters;
}
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
*
* @param pipelineParameters
* Contains a list of pipeline parameters. This list can be empty.
*/
public void setPipelineParameters(java.util.Collection pipelineParameters) {
if (pipelineParameters == null) {
this.pipelineParameters = null;
return;
}
this.pipelineParameters = new java.util.ArrayList(pipelineParameters);
}
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPipelineParameters(java.util.Collection)} or {@link #withPipelineParameters(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param pipelineParameters
* Contains a list of pipeline parameters. This list can be empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withPipelineParameters(Parameter... pipelineParameters) {
if (this.pipelineParameters == null) {
setPipelineParameters(new java.util.ArrayList(pipelineParameters.length));
}
for (Parameter ele : pipelineParameters) {
this.pipelineParameters.add(ele);
}
return this;
}
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
*
* @param pipelineParameters
* Contains a list of pipeline parameters. This list can be empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withPipelineParameters(java.util.Collection pipelineParameters) {
setPipelineParameters(pipelineParameters);
return this;
}
/**
*
* The description of the pipeline execution.
*
*
* @param pipelineExecutionDescription
* The description of the pipeline execution.
*/
public void setPipelineExecutionDescription(String pipelineExecutionDescription) {
this.pipelineExecutionDescription = pipelineExecutionDescription;
}
/**
*
* The description of the pipeline execution.
*
*
* @return The description of the pipeline execution.
*/
public String getPipelineExecutionDescription() {
return this.pipelineExecutionDescription;
}
/**
*
* The description of the pipeline execution.
*
*
* @param pipelineExecutionDescription
* The description of the pipeline execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withPipelineExecutionDescription(String pipelineExecutionDescription) {
setPipelineExecutionDescription(pipelineExecutionDescription);
return this;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
* operation completes no more than once.
*
*
* @param clientRequestToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An
* idempotent operation completes no more than once.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
* operation completes no more than once.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An
* idempotent operation completes no more than once.
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
* operation completes no more than once.
*
*
* @param clientRequestToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An
* idempotent operation completes no more than once.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
*
* This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this
* specific run.
*
*
* @param parallelismConfiguration
* This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this
* specific run.
*/
public void setParallelismConfiguration(ParallelismConfiguration parallelismConfiguration) {
this.parallelismConfiguration = parallelismConfiguration;
}
/**
*
* This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this
* specific run.
*
*
* @return This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this
* specific run.
*/
public ParallelismConfiguration getParallelismConfiguration() {
return this.parallelismConfiguration;
}
/**
*
* This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this
* specific run.
*
*
* @param parallelismConfiguration
* This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this
* specific run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withParallelismConfiguration(ParallelismConfiguration parallelismConfiguration) {
setParallelismConfiguration(parallelismConfiguration);
return this;
}
/**
*
* The selective execution configuration applied to the pipeline run.
*
*
* @param selectiveExecutionConfig
* The selective execution configuration applied to the pipeline run.
*/
public void setSelectiveExecutionConfig(SelectiveExecutionConfig selectiveExecutionConfig) {
this.selectiveExecutionConfig = selectiveExecutionConfig;
}
/**
*
* The selective execution configuration applied to the pipeline run.
*
*
* @return The selective execution configuration applied to the pipeline run.
*/
public SelectiveExecutionConfig getSelectiveExecutionConfig() {
return this.selectiveExecutionConfig;
}
/**
*
* The selective execution configuration applied to the pipeline run.
*
*
* @param selectiveExecutionConfig
* The selective execution configuration applied to the pipeline run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPipelineExecutionRequest withSelectiveExecutionConfig(SelectiveExecutionConfig selectiveExecutionConfig) {
setSelectiveExecutionConfig(selectiveExecutionConfig);
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 (getPipelineExecutionDisplayName() != null)
sb.append("PipelineExecutionDisplayName: ").append(getPipelineExecutionDisplayName()).append(",");
if (getPipelineParameters() != null)
sb.append("PipelineParameters: ").append(getPipelineParameters()).append(",");
if (getPipelineExecutionDescription() != null)
sb.append("PipelineExecutionDescription: ").append(getPipelineExecutionDescription()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getParallelismConfiguration() != null)
sb.append("ParallelismConfiguration: ").append(getParallelismConfiguration()).append(",");
if (getSelectiveExecutionConfig() != null)
sb.append("SelectiveExecutionConfig: ").append(getSelectiveExecutionConfig());
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.getPipelineName() == null ^ this.getPipelineName() == null)
return false;
if (other.getPipelineName() != null && other.getPipelineName().equals(this.getPipelineName()) == false)
return false;
if (other.getPipelineExecutionDisplayName() == null ^ this.getPipelineExecutionDisplayName() == null)
return false;
if (other.getPipelineExecutionDisplayName() != null && other.getPipelineExecutionDisplayName().equals(this.getPipelineExecutionDisplayName()) == false)
return false;
if (other.getPipelineParameters() == null ^ this.getPipelineParameters() == null)
return false;
if (other.getPipelineParameters() != null && other.getPipelineParameters().equals(this.getPipelineParameters()) == false)
return false;
if (other.getPipelineExecutionDescription() == null ^ this.getPipelineExecutionDescription() == null)
return false;
if (other.getPipelineExecutionDescription() != null && other.getPipelineExecutionDescription().equals(this.getPipelineExecutionDescription()) == 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.getParallelismConfiguration() == null ^ this.getParallelismConfiguration() == null)
return false;
if (other.getParallelismConfiguration() != null && other.getParallelismConfiguration().equals(this.getParallelismConfiguration()) == false)
return false;
if (other.getSelectiveExecutionConfig() == null ^ this.getSelectiveExecutionConfig() == null)
return false;
if (other.getSelectiveExecutionConfig() != null && other.getSelectiveExecutionConfig().equals(this.getSelectiveExecutionConfig()) == 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 + ((getPipelineExecutionDisplayName() == null) ? 0 : getPipelineExecutionDisplayName().hashCode());
hashCode = prime * hashCode + ((getPipelineParameters() == null) ? 0 : getPipelineParameters().hashCode());
hashCode = prime * hashCode + ((getPipelineExecutionDescription() == null) ? 0 : getPipelineExecutionDescription().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getParallelismConfiguration() == null) ? 0 : getParallelismConfiguration().hashCode());
hashCode = prime * hashCode + ((getSelectiveExecutionConfig() == null) ? 0 : getSelectiveExecutionConfig().hashCode());
return hashCode;
}
@Override
public StartPipelineExecutionRequest clone() {
return (StartPipelineExecutionRequest) super.clone();
}
}