software.amazon.awssdk.services.osis.model

Class CreatePipelineRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.osis.model.OsisRequest

software.amazon.awssdk.services.osis.model.CreatePipelineRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreatePipelineRequest
extends OsisRequest
implements ToCopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreatePipelineRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreatePipelineRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
LogPublishingOptions	logPublishingOptions() Key-value pairs to configure log publishing.
Integer	maxUnits() The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
Integer	minUnits() The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
String	pipelineConfigurationBody() The pipeline configuration in YAML format.
String	pipelineName() The name of the OpenSearch Ingestion pipeline to create.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePipelineRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() List of tags to add to the pipeline upon creation.
CreatePipelineRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VpcOptions	vpcOptions() Container for the values required to configure VPC access for the pipeline.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

pipelineName

public final 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.

Returns:

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.

minUnits

public final Integer minUnits()

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

maxUnits

public final Integer maxUnits()

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

pipelineConfigurationBody

public final 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.

Returns:

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.

logPublishingOptions

public final LogPublishingOptions logPublishingOptions()

Key-value pairs to configure log publishing.

Returns:

Key-value pairs to configure log publishing.

vpcOptions

public final 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.

Returns:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

List of tags to add to the pipeline upon creation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

List of tags to add to the pipeline upon creation.

toBuilder

public CreatePipelineRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>

Specified by:

toBuilder in class OsisRequest

builder

public static CreatePipelineRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePipelineRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo