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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPayloads() For responses, this returns true if the service returned a value for the Payloads property.
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()
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

pipelineActivity

public final PipelineActivity pipelineActivity()

The pipeline activity that is run. This must not be a channel activity or a data store 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 data store 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.

hasPayloads

public final boolean hasPayloads()

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

payloads

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

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

Returns:

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

toBuilder

public RunPipelineActivityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RunPipelineActivityRequest.Builder,RunPipelineActivityRequest>

Specified by:

toBuilder in class IoTAnalyticsRequest

builder

public static RunPipelineActivityRequest.Builder builder()

serializableBuilderClass

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