Package software.amazon.awssdk.services.osis.model

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

Modifier and Type	Method	Description
default CreatePipelineRequest.Builder	bufferOptions(Consumer<BufferOptions.Builder> bufferOptions)	Key-value pairs to configure persistent buffering for the pipeline.
CreatePipelineRequest.Builder	bufferOptions(BufferOptions bufferOptions)	Key-value pairs to configure persistent buffering for the pipeline.
default CreatePipelineRequest.Builder	encryptionAtRestOptions(Consumer<EncryptionAtRestOptions.Builder> encryptionAtRestOptions)	Key-value pairs to configure encryption for data that is written to a persistent buffer.
CreatePipelineRequest.Builder	encryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)	Key-value pairs to configure encryption for data that is written to a persistent buffer.
default CreatePipelineRequest.Builder	logPublishingOptions(Consumer<LogPublishingOptions.Builder> logPublishingOptions)	Key-value pairs to configure log publishing.
CreatePipelineRequest.Builder	logPublishingOptions(LogPublishingOptions logPublishingOptions)	Key-value pairs to configure log publishing.
CreatePipelineRequest.Builder	maxUnits(Integer maxUnits)	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
CreatePipelineRequest.Builder	minUnits(Integer minUnits)	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
CreatePipelineRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreatePipelineRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreatePipelineRequest.Builder	pipelineConfigurationBody(String pipelineConfigurationBody)	The pipeline configuration in YAML format.
CreatePipelineRequest.Builder	pipelineName(String pipelineName)	The name of the OpenSearch Ingestion pipeline to create.
CreatePipelineRequest.Builder	tags(Collection<Tag> tags)	List of tags to add to the pipeline upon creation.
CreatePipelineRequest.Builder	tags(Consumer<Tag.Builder>... tags)	List of tags to add to the pipeline upon creation.
CreatePipelineRequest.Builder	tags(Tag... tags)	List of tags to add to the pipeline upon creation.
default CreatePipelineRequest.Builder	vpcOptions(Consumer<VpcOptions.Builder> vpcOptions)	Container for the values required to configure VPC access for the pipeline.
CreatePipelineRequest.Builder	vpcOptions(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 Details

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 the LogPublishingOptions.Builder avoiding the need to create one manually via LogPublishingOptions.builder().

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

Parameters:

logPublishingOptions - a consumer that will call methods on LogPublishingOptions.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 the VpcOptions.Builder avoiding the need to create one manually via VpcOptions.builder().

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

Parameters:

vpcOptions - a consumer that will call methods on VpcOptions.Builder

Returns:

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

See Also:

• vpcOptions(VpcOptions)

bufferOptions

CreatePipelineRequest.Builder bufferOptions(BufferOptions bufferOptions)

Key-value pairs to configure persistent buffering for the pipeline.

Parameters:

bufferOptions - Key-value pairs to configure persistent buffering for the pipeline.

Returns:

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

bufferOptions

default CreatePipelineRequest.Builder bufferOptions(Consumer<BufferOptions.Builder> bufferOptions)

Key-value pairs to configure persistent buffering for the pipeline.

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

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

Parameters:

bufferOptions - a consumer that will call methods on BufferOptions.Builder

Returns:

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

See Also:

• bufferOptions(BufferOptions)

encryptionAtRestOptions

CreatePipelineRequest.Builder encryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)

Key-value pairs to configure encryption for data that is written to a persistent buffer.

Parameters:

encryptionAtRestOptions - Key-value pairs to configure encryption for data that is written to a persistent buffer.

Returns:

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

encryptionAtRestOptions

default CreatePipelineRequest.Builder encryptionAtRestOptions(Consumer<EncryptionAtRestOptions.Builder> encryptionAtRestOptions)

Key-value pairs to configure encryption for data that is written to a persistent buffer.

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

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

Parameters:

encryptionAtRestOptions - a consumer that will call methods on EncryptionAtRestOptions.Builder

Returns:

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

See Also:

• encryptionAtRestOptions(EncryptionAtRestOptions)

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 the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

CreatePipelineRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreatePipelineRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.