Package software.amazon.awssdk.services.pipes.model

Class UpdatePipeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pipes.model.PipesRequest

software.amazon.awssdk.services.pipes.model.UpdatePipeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdatePipeRequest.Builder,UpdatePipeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdatePipeRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdatePipeRequest.Builder	builder()
String	description()	A description of the pipe.
RequestedPipeState	desiredState()	The state the pipe should be in.
String	desiredStateAsString()	The state the pipe should be in.
String	enrichment()	The ARN of the enrichment resource.
PipeEnrichmentParameters	enrichmentParameters()	The parameters required to set up enrichment on your pipe.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PipeLogConfigurationParameters	logConfiguration()	The logging configuration settings for the pipe.
String	name()	The name of the pipe.
String	roleArn()	The ARN of the role that allows the pipe to send data to the target.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdatePipeRequest.Builder>	serializableBuilderClass()
UpdatePipeSourceParameters	sourceParameters()	The parameters required to set up a source for your pipe.
String	target()	The ARN of the target resource.
PipeTargetParameters	targetParameters()	The parameters required to set up a target for your pipe.
UpdatePipeRequest.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

description

public final String description()

A description of the pipe.

Returns:

A description of the pipe.

desiredState

public final RequestedPipeState desiredState()

The state the pipe should be in.

If the service returns an enum value that is not available in the current SDK version, desiredState will return RequestedPipeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

Returns:

The state the pipe should be in.

See Also:

RequestedPipeState

desiredStateAsString

public final String desiredStateAsString()

The state the pipe should be in.

If the service returns an enum value that is not available in the current SDK version, desiredState will return RequestedPipeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

Returns:

The state the pipe should be in.

See Also:

RequestedPipeState

enrichment

public final String enrichment()

The ARN of the enrichment resource.

Returns:

The ARN of the enrichment resource.

enrichmentParameters

public final PipeEnrichmentParameters enrichmentParameters()

The parameters required to set up enrichment on your pipe.

Returns:

The parameters required to set up enrichment on your pipe.

logConfiguration

public final PipeLogConfigurationParameters logConfiguration()

The logging configuration settings for the pipe.

Returns:

The logging configuration settings for the pipe.

name

public final String name()

The name of the pipe.

Returns:

The name of the pipe.

roleArn

public final String roleArn()

The ARN of the role that allows the pipe to send data to the target.

Returns:

The ARN of the role that allows the pipe to send data to the target.

sourceParameters

public final UpdatePipeSourceParameters sourceParameters()

The parameters required to set up a source for your pipe.

Returns:

The parameters required to set up a source for your pipe.

target

public final String target()

The ARN of the target resource.

Returns:

The ARN of the target resource.

targetParameters

public final PipeTargetParameters targetParameters()

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

Returns:

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

toBuilder

public UpdatePipeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdatePipeRequest.Builder,UpdatePipeRequest>

Specified by:

toBuilder in class PipesRequest

builder

public static UpdatePipeRequest.Builder builder()

serializableBuilderClass

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