Interface DescribePipeResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribePipeResponse.Builder,DescribePipeResponse>,PipesResponse.Builder,SdkBuilder<DescribePipeResponse.Builder,DescribePipeResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribePipeResponse
public static interface DescribePipeResponse.Builder extends PipesResponse.Builder, SdkPojo, CopyableBuilder<DescribePipeResponse.Builder,DescribePipeResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribePipeResponse.Builderarn(String arn)The ARN of the pipe.DescribePipeResponse.BuildercreationTime(Instant creationTime)The time the pipe was created.DescribePipeResponse.BuildercurrentState(String currentState)The state the pipe is in.DescribePipeResponse.BuildercurrentState(PipeState currentState)The state the pipe is in.DescribePipeResponse.Builderdescription(String description)A description of the pipe.DescribePipeResponse.BuilderdesiredState(String desiredState)The state the pipe should be in.DescribePipeResponse.BuilderdesiredState(RequestedPipeStateDescribeResponse desiredState)The state the pipe should be in.DescribePipeResponse.Builderenrichment(String enrichment)The ARN of the enrichment resource.default DescribePipeResponse.BuilderenrichmentParameters(Consumer<PipeEnrichmentParameters.Builder> enrichmentParameters)The parameters required to set up enrichment on your pipe.DescribePipeResponse.BuilderenrichmentParameters(PipeEnrichmentParameters enrichmentParameters)The parameters required to set up enrichment on your pipe.DescribePipeResponse.BuilderlastModifiedTime(Instant lastModifiedTime)When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).default DescribePipeResponse.BuilderlogConfiguration(Consumer<PipeLogConfiguration.Builder> logConfiguration)The logging configuration settings for the pipe.DescribePipeResponse.BuilderlogConfiguration(PipeLogConfiguration logConfiguration)The logging configuration settings for the pipe.DescribePipeResponse.Buildername(String name)The name of the pipe.DescribePipeResponse.BuilderroleArn(String roleArn)The ARN of the role that allows the pipe to send data to the target.DescribePipeResponse.Buildersource(String source)The ARN of the source resource.default DescribePipeResponse.BuildersourceParameters(Consumer<PipeSourceParameters.Builder> sourceParameters)The parameters required to set up a source for your pipe.DescribePipeResponse.BuildersourceParameters(PipeSourceParameters sourceParameters)The parameters required to set up a source for your pipe.DescribePipeResponse.BuilderstateReason(String stateReason)The reason the pipe is in its current state.DescribePipeResponse.Buildertags(Map<String,String> tags)The list of key-value pairs to associate with the pipe.DescribePipeResponse.Buildertarget(String target)The ARN of the target resource.default DescribePipeResponse.BuildertargetParameters(Consumer<PipeTargetParameters.Builder> targetParameters)The parameters required to set up a target for your pipe.DescribePipeResponse.BuildertargetParameters(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 Detail
-
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.
-
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.
-
currentState
DescribePipeResponse.Builder currentState(String currentState)
The state the pipe is in.
-
currentState
DescribePipeResponse.Builder currentState(PipeState currentState)
The state the pipe is in.
-
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
-
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 thePipeEnrichmentParameters.Builderavoiding the need to create one manually viaPipeEnrichmentParameters.builder().When the
Consumercompletes,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:
enrichmentParameters(PipeEnrichmentParameters)
-
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 thePipeLogConfiguration.Builderavoiding the need to create one manually viaPipeLogConfiguration.builder().When the
Consumercompletes,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:
logConfiguration(PipeLogConfiguration)
-
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.
-
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.
-
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 thePipeSourceParameters.Builderavoiding the need to create one manually viaPipeSourceParameters.builder().When the
Consumercompletes,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:
sourceParameters(PipeSourceParameters)
-
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.
-
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.
-
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 thePipeTargetParameters.Builderavoiding the need to create one manually viaPipeTargetParameters.builder().When the
Consumercompletes,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:
targetParameters(PipeTargetParameters)
-
-