software.amazon.awssdk.services.codepipeline.model

Class StartPipelineExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest

software.amazon.awssdk.services.codepipeline.model.StartPipelineExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartPipelineExecutionRequest
extends CodePipelineRequest
implements ToCopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>

Represents the input of a StartPipelineExecution action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartPipelineExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartPipelineExecutionRequest.Builder	builder()
String	clientRequestToken() The system-generated unique ID used to identify a unique execution request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVariables() For responses, this returns true if the service returned a value for the Variables property.
String	name() The name of the pipeline to start.
List<SdkField<?>>	sdkFields()
static Class<? extends StartPipelineExecutionRequest.Builder>	serializableBuilderClass()
StartPipelineExecutionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<PipelineVariable>	variables() A list that overrides pipeline variables for a pipeline execution that's being started.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the pipeline to start.

Returns:

The name of the pipeline to start.

hasVariables

public final boolean hasVariables()

For responses, this returns true if the service returned a value for the Variables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

variables

public final List<PipelineVariable> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVariables() method.

Returns:

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.

clientRequestToken

public final String clientRequestToken()

The system-generated unique ID used to identify a unique execution request.

Returns:

The system-generated unique ID used to identify a unique execution request.

toBuilder

public StartPipelineExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>

Specified by:

toBuilder in class CodePipelineRequest

builder

public static StartPipelineExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartPipelineExecutionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo