Interface DescribePipeResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribePipeResponse.Builder,
,DescribePipeResponse> PipesResponse.Builder
,SdkBuilder<DescribePipeResponse.Builder,
,DescribePipeResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribePipeResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the pipe.creationTime
(Instant creationTime) The time the pipe was created.currentState
(String currentState) The state the pipe is in.currentState
(PipeState currentState) The state the pipe is in.description
(String description) A description of the pipe.desiredState
(String desiredState) The state the pipe should be in.desiredState
(RequestedPipeStateDescribeResponse desiredState) The state the pipe should be in.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.enrichmentParameters
(PipeEnrichmentParameters enrichmentParameters) The parameters required to set up enrichment on your pipe.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.logConfiguration
(PipeLogConfiguration logConfiguration) The logging configuration settings for the pipe.The name of the pipe.The ARN of the role that allows the pipe to send data to the target.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.sourceParameters
(PipeSourceParameters sourceParameters) The parameters required to set up a source for your pipe.stateReason
(String stateReason) The reason the pipe is in its current state.The list of key-value pairs to associate with the pipe.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.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, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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.
-
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.
-
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:
-
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:
-
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
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:
-
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:
-
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
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 thePipeEnrichmentParameters.Builder
avoiding the need to create one manually viaPipeEnrichmentParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenrichmentParameters(PipeEnrichmentParameters)
.- Parameters:
enrichmentParameters
- a consumer that will call methods onPipeEnrichmentParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 thePipeLogConfiguration.Builder
avoiding the need to create one manually viaPipeLogConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologConfiguration(PipeLogConfiguration)
.- Parameters:
logConfiguration
- a consumer that will call methods onPipeLogConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
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
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 thePipeSourceParameters.Builder
avoiding the need to create one manually viaPipeSourceParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceParameters(PipeSourceParameters)
.- Parameters:
sourceParameters
- a consumer that will call methods onPipeSourceParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
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
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 thePipeTargetParameters.Builder
avoiding the need to create one manually viaPipeTargetParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetParameters(PipeTargetParameters)
.- Parameters:
targetParameters
- a consumer that will call methods onPipeTargetParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-