Class Pipeline
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.Pipeline
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Pipeline.Builder,Pipeline>
@Generated("software.amazon.awssdk:codegen") public final class Pipeline extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Pipeline.Builder,Pipeline>
A SageMaker Model Building Pipeline instance.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Pipeline.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Pipeline.Builder
builder()
UserContext
createdBy()
Returns the value of the CreatedBy property for this object.Instant
creationTime()
The creation time of the pipeline.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.UserContext
lastModifiedBy()
Returns the value of the LastModifiedBy property for this object.Instant
lastModifiedTime()
The time that the pipeline was last modified.Instant
lastRunTime()
The time when the pipeline was last run.ParallelismConfiguration
parallelismConfiguration()
The parallelism configuration applied to the pipeline.String
pipelineArn()
The Amazon Resource Name (ARN) of the pipeline.String
pipelineDescription()
The description of the pipeline.String
pipelineDisplayName()
The display name of the pipeline.String
pipelineName()
The name of the pipeline.PipelineStatus
pipelineStatus()
The status of the pipeline.String
pipelineStatusAsString()
The status of the pipeline.String
roleArn()
The Amazon Resource Name (ARN) of the role that created the pipeline.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends Pipeline.Builder>
serializableBuilderClass()
List<Tag>
tags()
A list of tags that apply to the pipeline.Pipeline.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
-
pipelineArn
public final String pipelineArn()
The Amazon Resource Name (ARN) of the pipeline.
- Returns:
- The Amazon Resource Name (ARN) of the pipeline.
-
pipelineName
public final String pipelineName()
The name of the pipeline.
- Returns:
- The name of the pipeline.
-
pipelineDisplayName
public final String pipelineDisplayName()
The display name of the pipeline.
- Returns:
- The display name of the pipeline.
-
pipelineDescription
public final String pipelineDescription()
The description of the pipeline.
- Returns:
- The description of the pipeline.
-
roleArn
public final String 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
public final PipelineStatus 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:
PipelineStatus
-
pipelineStatusAsString
public final String 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:
PipelineStatus
-
creationTime
public final Instant creationTime()
The creation time of the pipeline.
- Returns:
- The creation time of the pipeline.
-
lastModifiedTime
public final Instant lastModifiedTime()
The time that the pipeline was last modified.
- Returns:
- The time that the pipeline was last modified.
-
lastRunTime
public final Instant lastRunTime()
The time when the pipeline was last run.
- Returns:
- The time when the pipeline was last run.
-
createdBy
public final UserContext createdBy()
Returns the value of the CreatedBy property for this object.- Returns:
- The value of the CreatedBy property for this object.
-
lastModifiedBy
public final UserContext lastModifiedBy()
Returns the value of the LastModifiedBy property for this object.- Returns:
- The value of the LastModifiedBy property for this object.
-
parallelismConfiguration
public final ParallelismConfiguration 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
public final List<Tag> 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
public Pipeline.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Pipeline.Builder,Pipeline>
-
builder
public static Pipeline.Builder builder()
-
serializableBuilderClass
public static Class<? extends Pipeline.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-