Package software.amazon.awssdk.services.datapipeline.model

Class ActivatePipelineRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datapipeline.model.DataPipelineRequest

software.amazon.awssdk.services.datapipeline.model.ActivatePipelineRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ActivatePipelineRequest.Builder,ActivatePipelineRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ActivatePipelineRequest
extends DataPipelineRequest
implements ToCopyableBuilder<ActivatePipelineRequest.Builder,ActivatePipelineRequest>

Contains the parameters for ActivatePipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActivatePipelineRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ActivatePipelineRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameterValues()	For responses, this returns true if the service returned a value for the ParameterValues property.
List<ParameterValue>	parameterValues()	A list of parameter values to pass to the pipeline at activation.
String	pipelineId()	The ID of the pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends ActivatePipelineRequest.Builder>	serializableBuilderClass()
Instant	startTimestamp()	The date and time to resume the pipeline.
ActivatePipelineRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

pipelineId

public final String pipelineId()

The ID of the pipeline.

Returns:

The ID of the pipeline.

hasParameterValues

public final boolean hasParameterValues()

For responses, this returns true if the service returned a value for the ParameterValues 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.

parameterValues

public final List<ParameterValue> parameterValues()

A list of parameter values to pass to the pipeline at activation.

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 hasParameterValues() method.

Returns:

A list of parameter values to pass to the pipeline at activation.

startTimestamp

public final Instant startTimestamp()

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

Returns:

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

toBuilder

public ActivatePipelineRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ActivatePipelineRequest.Builder,ActivatePipelineRequest>

Specified by:

toBuilder in class DataPipelineRequest

builder

public static ActivatePipelineRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ActivatePipelineRequest.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