Interface DescribePipeResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribePipeResponse.Builder,DescribePipeResponse>, PipesResponse.Builder, SdkBuilder<DescribePipeResponse.Builder,DescribePipeResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribePipeResponse

@Mutable
@NotThreadSafe
public static interface DescribePipeResponse.Builder
extends PipesResponse.Builder, SdkPojo, CopyableBuilder<DescribePipeResponse.Builder,DescribePipeResponse>

Method Summary

Modifier and Type	Method	Description
DescribePipeResponse.Builder	arn(String arn)	The ARN of the pipe.
DescribePipeResponse.Builder	creationTime(Instant creationTime)	The time the pipe was created.
DescribePipeResponse.Builder	currentState(String currentState)	The state the pipe is in.
DescribePipeResponse.Builder	currentState(PipeState currentState)	The state the pipe is in.
DescribePipeResponse.Builder	description(String description)	A description of the pipe.
DescribePipeResponse.Builder	desiredState(String desiredState)	The state the pipe should be in.
DescribePipeResponse.Builder	desiredState(RequestedPipeStateDescribeResponse desiredState)	The state the pipe should be in.
DescribePipeResponse.Builder	enrichment(String enrichment)	The ARN of the enrichment resource.
default DescribePipeResponse.Builder	enrichmentParameters(Consumer<PipeEnrichmentParameters.Builder> enrichmentParameters)	The parameters required to set up enrichment on your pipe.
DescribePipeResponse.Builder	enrichmentParameters(PipeEnrichmentParameters enrichmentParameters)	The parameters required to set up enrichment on your pipe.
DescribePipeResponse.Builder	kmsKeyIdentifier(String kmsKeyIdentifier)	The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.
DescribePipeResponse.Builder	lastModifiedTime(Instant lastModifiedTime)	When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
default DescribePipeResponse.Builder	logConfiguration(Consumer<PipeLogConfiguration.Builder> logConfiguration)	The logging configuration settings for the pipe.
DescribePipeResponse.Builder	logConfiguration(PipeLogConfiguration logConfiguration)	The logging configuration settings for the pipe.
DescribePipeResponse.Builder	name(String name)	The name of the pipe.
DescribePipeResponse.Builder	roleArn(String roleArn)	The ARN of the role that allows the pipe to send data to the target.
DescribePipeResponse.Builder	source(String source)	The ARN of the source resource.
default DescribePipeResponse.Builder	sourceParameters(Consumer<PipeSourceParameters.Builder> sourceParameters)	The parameters required to set up a source for your pipe.
DescribePipeResponse.Builder	sourceParameters(PipeSourceParameters sourceParameters)	The parameters required to set up a source for your pipe.
DescribePipeResponse.Builder	stateReason(String stateReason)	The reason the pipe is in its current state.
DescribePipeResponse.Builder	tags(Map<String,String> tags)	The list of key-value pairs to associate with the pipe.
DescribePipeResponse.Builder	target(String target)	The ARN of the target resource.
default DescribePipeResponse.Builder	targetParameters(Consumer<PipeTargetParameters.Builder> targetParameters)	The parameters required to set up a target for your pipe.
DescribePipeResponse.Builder	targetParameters(PipeTargetParameters targetParameters)	The parameters required to set up a target for your pipe.

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

copy

Methods inherited from interface software.amazon.awssdk.services.pipes.model.PipesResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

arn

DescribePipeResponse.Builder arn(String arn)

The ARN of the pipe.

Parameters:

arn - The ARN of the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

DescribePipeResponse.Builder name(String name)

The name of the pipe.

Parameters:

name - The name of the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

DescribePipeResponse.Builder description(String description)

A description of the pipe.

Parameters:

description - A description of the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

desiredState

DescribePipeResponse.Builder desiredState(String desiredState)

The state the pipe should be in.

Parameters:

desiredState - The state the pipe should be in.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RequestedPipeStateDescribeResponse
• RequestedPipeStateDescribeResponse

desiredState

DescribePipeResponse.Builder desiredState(RequestedPipeStateDescribeResponse desiredState)

The state the pipe should be in.

Parameters:

desiredState - The state the pipe should be in.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RequestedPipeStateDescribeResponse
• RequestedPipeStateDescribeResponse

currentState

DescribePipeResponse.Builder currentState(String currentState)

The state the pipe is in.

Parameters:

currentState - The state the pipe is in.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PipeState
• PipeState

currentState

DescribePipeResponse.Builder currentState(PipeState currentState)

The state the pipe is in.

Parameters:

currentState - The state the pipe is in.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PipeState
• PipeState

stateReason

DescribePipeResponse.Builder stateReason(String stateReason)

The reason the pipe is in its current state.

Parameters:

stateReason - The reason the pipe is in its current state.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

DescribePipeResponse.Builder source(String source)

The ARN of the source resource.

Parameters:

source - The ARN of the source resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceParameters

DescribePipeResponse.Builder sourceParameters(PipeSourceParameters sourceParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceParameters

default DescribePipeResponse.Builder sourceParameters(Consumer<PipeSourceParameters.Builder> sourceParameters)

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

This is a convenience method that creates an instance of the PipeSourceParameters.Builder avoiding the need to create one manually via PipeSourceParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceParameters(PipeSourceParameters).

Parameters:

sourceParameters - a consumer that will call methods on PipeSourceParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sourceParameters(PipeSourceParameters)

enrichment

DescribePipeResponse.Builder enrichment(String enrichment)

The ARN of the enrichment resource.

Parameters:

enrichment - The ARN of the enrichment resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

enrichmentParameters

DescribePipeResponse.Builder enrichmentParameters(PipeEnrichmentParameters enrichmentParameters)

The parameters required to set up enrichment on your pipe.

Parameters:

enrichmentParameters - The parameters required to set up enrichment on your pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

enrichmentParameters

default DescribePipeResponse.Builder enrichmentParameters(Consumer<PipeEnrichmentParameters.Builder> enrichmentParameters)

The parameters required to set up enrichment on your pipe.

This is a convenience method that creates an instance of the PipeEnrichmentParameters.Builder avoiding the need to create one manually via PipeEnrichmentParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to enrichmentParameters(PipeEnrichmentParameters).

Parameters:

enrichmentParameters - a consumer that will call methods on PipeEnrichmentParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• enrichmentParameters(PipeEnrichmentParameters)

target

DescribePipeResponse.Builder target(String target)

The ARN of the target resource.

Parameters:

target - The ARN of the target resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetParameters

DescribePipeResponse.Builder targetParameters(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

targetParameters

default DescribePipeResponse.Builder targetParameters(Consumer<PipeTargetParameters.Builder> 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.

This is a convenience method that creates an instance of the PipeTargetParameters.Builder avoiding the need to create one manually via PipeTargetParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetParameters(PipeTargetParameters).

Parameters:

targetParameters - a consumer that will call methods on PipeTargetParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• targetParameters(PipeTargetParameters)

roleArn

DescribePipeResponse.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

DescribePipeResponse.Builder tags(Map<String,String> tags)

The list of key-value pairs to associate with the pipe.

Parameters:

tags - The list of key-value pairs to associate with the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

DescribePipeResponse.Builder creationTime(Instant creationTime)

The time the pipe was created.

Parameters:

creationTime - The time the pipe was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedTime

DescribePipeResponse.Builder lastModifiedTime(Instant lastModifiedTime)

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Parameters:

lastModifiedTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Returns:

Returns a reference to this object so that method calls can be chained together.

logConfiguration

DescribePipeResponse.Builder logConfiguration(PipeLogConfiguration logConfiguration)

The logging configuration settings for the pipe.

Parameters:

logConfiguration - The logging configuration settings for the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

logConfiguration

default DescribePipeResponse.Builder logConfiguration(Consumer<PipeLogConfiguration.Builder> logConfiguration)

The logging configuration settings for the pipe.

This is a convenience method that creates an instance of the PipeLogConfiguration.Builder avoiding the need to create one manually via PipeLogConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logConfiguration(PipeLogConfiguration).

Parameters:

logConfiguration - a consumer that will call methods on PipeLogConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• logConfiguration(PipeLogConfiguration)

kmsKeyIdentifier

DescribePipeResponse.Builder kmsKeyIdentifier(String kmsKeyIdentifier)

The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

Parameters:

kmsKeyIdentifier - The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.