Class Pipeline
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Pipeline.Builder,
Pipeline>
A SageMaker Model Building Pipeline instance.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Pipeline.Builder
builder()
final UserContext
Returns the value of the CreatedBy property for this object.final Instant
The creation time of the pipeline.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 UserContext
Returns the value of the LastModifiedBy property for this object.final Instant
The time that the pipeline was last modified.final Instant
The time when the pipeline was last run.final ParallelismConfiguration
The parallelism configuration applied to the pipeline.final String
The Amazon Resource Name (ARN) of the pipeline.final String
The description of the pipeline.final String
The display name of the pipeline.final String
The name of the pipeline.final PipelineStatus
The status of the pipeline.final String
The status of the pipeline.final String
roleArn()
The Amazon Resource Name (ARN) of the role that created the pipeline.static Class
<? extends Pipeline.Builder> tags()
A list of tags that apply to the 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
-
pipelineArn
The Amazon Resource Name (ARN) of the pipeline.
- Returns:
- The Amazon Resource Name (ARN) of the pipeline.
-
pipelineName
The name of the pipeline.
- Returns:
- The name of the pipeline.
-
pipelineDisplayName
The display name of the pipeline.
- Returns:
- The display name of the pipeline.
-
pipelineDescription
The description of the pipeline.
- Returns:
- The description of the pipeline.
-
roleArn
The Amazon Resource Name (ARN) of the role that created the pipeline.
- Returns:
- The Amazon Resource Name (ARN) of the role that created the pipeline.
-
pipelineStatus
The status of the pipeline.
If the service returns an enum value that is not available in the current SDK version,
pipelineStatus
will returnPipelineStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompipelineStatusAsString()
.- Returns:
- The status of the pipeline.
- See Also:
-
pipelineStatusAsString
The status of the pipeline.
If the service returns an enum value that is not available in the current SDK version,
pipelineStatus
will returnPipelineStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompipelineStatusAsString()
.- Returns:
- The status of the pipeline.
- See Also:
-
creationTime
The creation time of the pipeline.
- Returns:
- The creation time of the pipeline.
-
lastModifiedTime
The time that the pipeline was last modified.
- Returns:
- The time that the pipeline was last modified.
-
lastRunTime
The time when the pipeline was last run.
- Returns:
- The time when the pipeline was last run.
-
createdBy
Returns the value of the CreatedBy property for this object.- Returns:
- The value of the CreatedBy property for this object.
-
lastModifiedBy
Returns the value of the LastModifiedBy property for this object.- Returns:
- The value of the LastModifiedBy property for this object.
-
parallelismConfiguration
The parallelism configuration applied to the pipeline.
- Returns:
- The parallelism configuration applied to the pipeline.
-
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 that apply 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
hasTags()
method.- Returns:
- A list of tags that apply to the 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<Pipeline.Builder,
Pipeline> - 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
-