Class PipelineSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PipelineSummary.Builder,
PipelineSummary>
Summary information for an OpenSearch Ingestion pipeline.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PipelineSummary.Builder
builder()
final Instant
The date and time when the pipeline was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Instant
The date and time when the pipeline was last updated.final Integer
maxUnits()
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).final Integer
minUnits()
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).final String
The Amazon Resource Name (ARN) of the pipeline.final String
The name of the pipeline.static Class
<? extends PipelineSummary.Builder> final PipelineStatus
status()
The current status of the pipeline.final String
The current status of the pipeline.final PipelineStatusReason
Returns the value of the StatusReason property for this object.tags()
A list of tags associated with the given pipeline.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnPipelineStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the pipeline.
- See Also:
-
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 returnPipelineStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the pipeline.
- See Also:
-
statusReason
Returns the value of the StatusReason property for this object.- Returns:
- The value of the StatusReason property for this object.
-
pipelineName
The name of the pipeline.
- Returns:
- The name of the pipeline.
-
pipelineArn
The Amazon Resource Name (ARN) of the pipeline.
- Returns:
- The Amazon Resource Name (ARN) of the pipeline.
-
minUnits
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
- Returns:
- The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
-
maxUnits
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
- Returns:
- The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
-
createdAt
The date and time when the pipeline was created.
- Returns:
- The date and time when the pipeline was created.
-
lastUpdatedAt
The date and time when the pipeline was last updated.
- Returns:
- The date and time when the pipeline was last updated.
-
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 theisEmpty()
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
A list of tags associated with the given 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
hasTags()
method.- Returns:
- A list of tags associated with the given pipeline.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PipelineSummary.Builder,
PipelineSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-