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

Class PipelineSummary

java.lang.Object

software.amazon.awssdk.services.osis.model.PipelineSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipelineSummary.Builder,PipelineSummary>

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

Summary information for an OpenSearch Ingestion pipeline.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipelineSummary.Builder

Method Summary

Modifier and Type	Method	Description
static PipelineSummary.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()
Instant	lastUpdatedAt()	The date and time when the pipeline was last updated.
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	pipelineName()	The name of the pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends PipelineSummary.Builder>	serializableBuilderClass()
PipelineStatus	status()	The current status of the pipeline.
String	statusAsString()	The current status of the pipeline.
PipelineStatusReason	statusReason()	Returns the value of the StatusReason property for this object.
PipelineSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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()

Returns the value of the StatusReason property for this object.

Returns:

The value of the StatusReason property for this object.

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

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.

toBuilder

public PipelineSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipelineSummary.Builder,PipelineSummary>

builder

public static PipelineSummary.Builder builder()

serializableBuilderClass

public static Class<? extends PipelineSummary.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