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

Interface Pipeline.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Pipeline.Builder,Pipeline>, SdkBuilder<Pipeline.Builder,Pipeline>, SdkPojo
Enclosing class:
Pipeline
public static interface Pipeline.Builder extends SdkPojo, CopyableBuilder<Pipeline.Builder,Pipeline>

  • Method Details

    • pipelineName

      Pipeline.Builder pipelineName(String pipelineName)

      The name of the pipeline.

      Parameters:
      pipelineName - The name of the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pipelineArn

      Pipeline.Builder pipelineArn(String pipelineArn)

      The Amazon Resource Name (ARN) of the pipeline.

      Parameters:
      pipelineArn - The Amazon Resource Name (ARN) of the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minUnits

      Pipeline.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

      Pipeline.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.

    • status

      Pipeline.Builder status(String status)

      The current status of the pipeline.

      Parameters:
      status - The current status of the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Pipeline.Builder status(PipelineStatus status)

      The current status of the pipeline.

      Parameters:
      status - The current status of the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      Pipeline.Builder statusReason(PipelineStatusReason statusReason)

      The reason for the current status of the pipeline.

      Parameters:
      statusReason - The reason for the current status of the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusReason

      default Pipeline.Builder statusReason(Consumer<PipelineStatusReason.Builder> statusReason)

      The reason for the current status of the pipeline.

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

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

      Parameters:
      statusReason - a consumer that will call methods on PipelineStatusReason.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pipelineConfigurationBody

      Pipeline.Builder pipelineConfigurationBody(String pipelineConfigurationBody)

      The Data Prepper pipeline configuration in YAML format.

      Parameters:
      pipelineConfigurationBody - The Data Prepper pipeline configuration in YAML format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      Pipeline.Builder createdAt(Instant createdAt)

      The date and time when the pipeline was created.

      Parameters:
      createdAt - The date and time when the pipeline was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      Pipeline.Builder lastUpdatedAt(Instant lastUpdatedAt)

      The date and time when the pipeline was last updated.

      Parameters:
      lastUpdatedAt - The date and time when the pipeline was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ingestEndpointUrls

      Pipeline.Builder ingestEndpointUrls(Collection<String> ingestEndpointUrls)

      The ingestion endpoints for the pipeline, which you can send data to.

      Parameters:
      ingestEndpointUrls - The ingestion endpoints for the pipeline, which you can send data to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ingestEndpointUrls

      Pipeline.Builder ingestEndpointUrls(String... ingestEndpointUrls)

      The ingestion endpoints for the pipeline, which you can send data to.

      Parameters:
      ingestEndpointUrls - The ingestion endpoints for the pipeline, which you can send data to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPublishingOptions

      Pipeline.Builder logPublishingOptions(LogPublishingOptions logPublishingOptions)

      Key-value pairs that represent log publishing settings.

      Parameters:
      logPublishingOptions - Key-value pairs that represent log publishing settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPublishingOptions

      default Pipeline.Builder logPublishingOptions(Consumer<LogPublishingOptions.Builder> logPublishingOptions)

      Key-value pairs that represent log publishing settings.

      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:

    • vpcEndpoints

      Pipeline.Builder vpcEndpoints(Collection<VpcEndpoint> vpcEndpoints)

      The VPC interface endpoints that have access to the pipeline.

      Parameters:
      vpcEndpoints - The VPC interface endpoints that have access to the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcEndpoints

      Pipeline.Builder vpcEndpoints(VpcEndpoint... vpcEndpoints)

      The VPC interface endpoints that have access to the pipeline.

      Parameters:
      vpcEndpoints - The VPC interface endpoints that have access to the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcEndpoints

      Pipeline.Builder vpcEndpoints(Consumer<VpcEndpoint.Builder>... vpcEndpoints)

      The VPC interface endpoints that have access to the pipeline.

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

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

      Parameters:
      vpcEndpoints - a consumer that will call methods on VpcEndpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bufferOptions

      Pipeline.Builder bufferOptions(BufferOptions bufferOptions)
      Sets the value of the BufferOptions property for this object.
      Parameters:
      bufferOptions - The new value for the BufferOptions property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bufferOptions

      default Pipeline.Builder bufferOptions(Consumer<BufferOptions.Builder> bufferOptions)
      Sets the value of the BufferOptions property for this object. 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:

    • encryptionAtRestOptions

      Pipeline.Builder encryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)
      Sets the value of the EncryptionAtRestOptions property for this object.
      Parameters:
      encryptionAtRestOptions - The new value for the EncryptionAtRestOptions property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionAtRestOptions

      default Pipeline.Builder encryptionAtRestOptions(Consumer<EncryptionAtRestOptions.Builder> encryptionAtRestOptions)
      Sets the value of the EncryptionAtRestOptions property for this object. 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:

    • serviceVpcEndpoints

      Pipeline.Builder serviceVpcEndpoints(Collection<ServiceVpcEndpoint> serviceVpcEndpoints)

      A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

      Parameters:
      serviceVpcEndpoints - A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceVpcEndpoints

      Pipeline.Builder serviceVpcEndpoints(ServiceVpcEndpoint... serviceVpcEndpoints)

      A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

      Parameters:
      serviceVpcEndpoints - A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceVpcEndpoints

      Pipeline.Builder serviceVpcEndpoints(Consumer<ServiceVpcEndpoint.Builder>... serviceVpcEndpoints)

      A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

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

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

      Parameters:
      serviceVpcEndpoints - a consumer that will call methods on ServiceVpcEndpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      Pipeline.Builder tags(Collection<Tag> tags)

      A list of tags associated with the given pipeline.

      Parameters:
      tags - A list of tags associated with the given pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Pipeline.Builder tags(Tag... tags)

      A list of tags associated with the given pipeline.

      Parameters:
      tags - A list of tags associated with the given pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Pipeline.Builder tags(Consumer<Tag.Builder>... tags)

      A list of tags associated with the given pipeline.

      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: