Interface CreatePipelineRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>,OsisRequest.Builder,SdkBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreatePipelineRequest
public static interface CreatePipelineRequest.Builder extends OsisRequest.Builder, SdkPojo, CopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CreatePipelineRequest.BuilderlogPublishingOptions(Consumer<LogPublishingOptions.Builder> logPublishingOptions)Key-value pairs to configure log publishing.CreatePipelineRequest.BuilderlogPublishingOptions(LogPublishingOptions logPublishingOptions)Key-value pairs to configure log publishing.CreatePipelineRequest.BuildermaxUnits(Integer maxUnits)The maximum pipeline capacity, in Ingestion Compute Units (ICUs).CreatePipelineRequest.BuilderminUnits(Integer minUnits)The minimum pipeline capacity, in Ingestion Compute Units (ICUs).CreatePipelineRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreatePipelineRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreatePipelineRequest.BuilderpipelineConfigurationBody(String pipelineConfigurationBody)The pipeline configuration in YAML format.CreatePipelineRequest.BuilderpipelineName(String pipelineName)The name of the OpenSearch Ingestion pipeline to create.CreatePipelineRequest.Buildertags(Collection<Tag> tags)List of tags to add to the pipeline upon creation.CreatePipelineRequest.Buildertags(Consumer<Tag.Builder>... tags)List of tags to add to the pipeline upon creation.CreatePipelineRequest.Buildertags(Tag... tags)List of tags to add to the pipeline upon creation.default CreatePipelineRequest.BuildervpcOptions(Consumer<VpcOptions.Builder> vpcOptions)Container for the values required to configure VPC access for the pipeline.CreatePipelineRequest.BuildervpcOptions(VpcOptions vpcOptions)Container for the values required to configure VPC access for the pipeline.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.osis.model.OsisRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
pipelineName
CreatePipelineRequest.Builder pipelineName(String pipelineName)
The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.
- Parameters:
pipelineName- The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
minUnits
CreatePipelineRequest.Builder minUnits(Integer minUnits)
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
- Parameters:
minUnits- The minimum pipeline capacity, in Ingestion Compute Units (ICUs).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxUnits
CreatePipelineRequest.Builder maxUnits(Integer maxUnits)
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
- Parameters:
maxUnits- The maximum pipeline capacity, in Ingestion Compute Units (ICUs).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pipelineConfigurationBody
CreatePipelineRequest.Builder pipelineConfigurationBody(String pipelineConfigurationBody)
The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with
\n.- Parameters:
pipelineConfigurationBody- The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with\n.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logPublishingOptions
CreatePipelineRequest.Builder logPublishingOptions(LogPublishingOptions logPublishingOptions)
Key-value pairs to configure log publishing.
- Parameters:
logPublishingOptions- Key-value pairs to configure log publishing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logPublishingOptions
default CreatePipelineRequest.Builder logPublishingOptions(Consumer<LogPublishingOptions.Builder> logPublishingOptions)
Key-value pairs to configure log publishing.
This is a convenience method that creates an instance of theLogPublishingOptions.Builderavoiding the need to create one manually viaLogPublishingOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tologPublishingOptions(LogPublishingOptions).- Parameters:
logPublishingOptions- a consumer that will call methods onLogPublishingOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
logPublishingOptions(LogPublishingOptions)
-
vpcOptions
CreatePipelineRequest.Builder vpcOptions(VpcOptions vpcOptions)
Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.
- Parameters:
vpcOptions- Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcOptions
default CreatePipelineRequest.Builder vpcOptions(Consumer<VpcOptions.Builder> vpcOptions)
Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.
This is a convenience method that creates an instance of theVpcOptions.Builderavoiding the need to create one manually viaVpcOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovpcOptions(VpcOptions).- Parameters:
vpcOptions- a consumer that will call methods onVpcOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
vpcOptions(VpcOptions)
-
tags
CreatePipelineRequest.Builder tags(Collection<Tag> tags)
List of tags to add to the pipeline upon creation.
- Parameters:
tags- List of tags to add to the pipeline upon creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreatePipelineRequest.Builder tags(Tag... tags)
List of tags to add to the pipeline upon creation.
- Parameters:
tags- List of tags to add to the pipeline upon creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreatePipelineRequest.Builder tags(Consumer<Tag.Builder>... tags)
List of tags to add to the pipeline upon creation.
This is a convenience method that creates an instance of theTag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
overrideConfiguration
CreatePipelineRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreatePipelineRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-