software.amazon.awssdk.services.iotanalytics.model

Class RunPipelineActivityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotanalytics.model.IoTAnalyticsRequest

software.amazon.awssdk.services.iotanalytics.model.RunPipelineActivityRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RunPipelineActivityRequest.Builder,RunPipelineActivityRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RunPipelineActivityRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RunPipelineActivityRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkBytes>	payloads() The sample message payloads on which the pipeline activity is run.
PipelineActivity	pipelineActivity() The pipeline activity that is run.
List<SdkField<?>>	sdkFields()
static Class<? extends RunPipelineActivityRequest.Builder>	serializableBuilderClass()
RunPipelineActivityRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pipelineActivity

public PipelineActivity pipelineActivity()

The pipeline activity that is run. This must not be a 'channel' activity or a 'datastore' activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a 'lambda' activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.

Returns:

The pipeline activity that is run. This must not be a 'channel' activity or a 'datastore' activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a 'lambda' activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.

payloads

public List<SdkBytes> payloads()

The sample message payloads on which the pipeline activity is run.

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

Returns:

The sample message payloads on which the pipeline activity is run.

toBuilder

public RunPipelineActivityRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RunPipelineActivityRequest.Builder,RunPipelineActivityRequest>

Specified by:

toBuilder in class IoTAnalyticsRequest

Returns:

a builder for type T

builder

public static RunPipelineActivityRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.