Pipeline (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.osis.model.Pipeline

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Pipeline.Builder,Pipeline>

@Generated(value="software.amazon.awssdk:codegen")
public final class Pipeline
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Pipeline.Builder,Pipeline>

Information about an existing OpenSearch Ingestion pipeline.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Pipeline.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Pipeline.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Pipeline.Builder`	`builder()`
`Instant`	`createdAt()` The date and time when the pipeline was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasIngestEndpointUrls()` For responses, this returns true if the service returned a value for the IngestEndpointUrls property.
`boolean`	`hasVpcEndpoints()` For responses, this returns true if the service returned a value for the VpcEndpoints property.
`List<String>`	`ingestEndpointUrls()` The ingestion endpoints for the pipeline, which you can send data to.
`Instant`	`lastUpdatedAt()` The date and time when the pipeline was last updated.
`LogPublishingOptions`	`logPublishingOptions()` Key-value pairs that represent log publishing settings.
`Integer`	`maxUnits()` The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
`Integer`	`minUnits()` The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
`String`	`pipelineArn()` The Amazon Resource Name (ARN) of the pipeline.
`String`	`pipelineConfigurationBody()` The Data Prepper pipeline configuration in YAML format.
`String`	`pipelineName()` The name of the pipeline.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Pipeline.Builder>`	`serializableBuilderClass()`
`PipelineStatus`	`status()` The current status of the pipeline.
`String`	`statusAsString()` The current status of the pipeline.
`PipelineStatusReason`	`statusReason()` The reason for the current status of the pipeline.
`Pipeline.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<VpcEndpoint>`	`vpcEndpoints()` The VPC interface endpoints that have access to the pipeline.

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 pipeline.
    
    Returns:
    
    The name of the pipeline.
  - pipelineArn
```
public final String pipelineArn()
```
    The Amazon Resource Name (ARN) of the pipeline.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the pipeline.
  - 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).
  - status
```
public final PipelineStatus status()
```
    The current status of the pipeline.
    
    If the service returns an enum value that is not available in the current SDK version, status will return PipelineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the pipeline.
    
    See Also:
    
    PipelineStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the pipeline.
    
    If the service returns an enum value that is not available in the current SDK version, status will return PipelineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the pipeline.
    
    See Also:
    
    PipelineStatus
  - statusReason
```
public final PipelineStatusReason statusReason()
```
    The reason for the current status of the pipeline.
    
    Returns:
    
    The reason for the current status of the pipeline.
  - pipelineConfigurationBody
```
public final String pipelineConfigurationBody()
```
    The Data Prepper pipeline configuration in YAML format.
    
    Returns:
    
    The Data Prepper pipeline configuration in YAML format.
  - createdAt
```
public final Instant createdAt()
```
    The date and time when the pipeline was created.
    
    Returns:
    
    The date and time when the pipeline was created.
  - lastUpdatedAt
```
public final Instant lastUpdatedAt()
```
    The date and time when the pipeline was last updated.
    
    Returns:
    
    The date and time when the pipeline was last updated.
  - hasIngestEndpointUrls
```
public final boolean hasIngestEndpointUrls()
```
    For responses, this returns true if the service returned a value for the IngestEndpointUrls 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.
  - ingestEndpointUrls
```
public final List<String> ingestEndpointUrls()
```
    The ingestion endpoints for the pipeline, which you can send data to.
    
    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 hasIngestEndpointUrls() method.
    
    Returns:
    
    The ingestion endpoints for the pipeline, which you can send data to.
  - logPublishingOptions
```
public final LogPublishingOptions logPublishingOptions()
```
    Key-value pairs that represent log publishing settings.
    
    Returns:
    
    Key-value pairs that represent log publishing settings.
  - hasVpcEndpoints
```
public final boolean hasVpcEndpoints()
```
    For responses, this returns true if the service returned a value for the VpcEndpoints 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.
  - vpcEndpoints
```
public final List<VpcEndpoint> vpcEndpoints()
```
    The VPC interface endpoints that have access to the pipeline.
    
    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 hasVpcEndpoints() method.
    
    Returns:
    
    The VPC interface endpoints that have access to the pipeline.
  - toBuilder
```
public Pipeline.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Pipeline.Builder,Pipeline>
  - builder
```
public static Pipeline.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Pipeline.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Pipeline

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

pipelineName

pipelineArn

minUnits

maxUnits

status

statusAsString

statusReason

pipelineConfigurationBody

createdAt

lastUpdatedAt

hasIngestEndpointUrls

ingestEndpointUrls

logPublishingOptions

hasVpcEndpoints

vpcEndpoints

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields