Package software.amazon.awssdk.services.sagemaker.model

Class CreatePipelineRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreatePipelineRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreatePipelineRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePipelineRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePipelineRequest.Builder	builder()
String	clientRequestToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation.
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.
ParallelismConfiguration	parallelismConfiguration()	This is the configuration that controls the parallelism of the pipeline.
String	pipelineDefinition()	The JSON pipeline definition of the pipeline.
PipelineDefinitionS3Location	pipelineDefinitionS3Location()	The location of the pipeline definition stored in Amazon S3.
String	pipelineDescription()	A description of the pipeline.
String	pipelineDisplayName()	The display name of the pipeline.
String	pipelineName()	The name of the pipeline.
String	roleArn()	The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePipelineRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of tags to apply to the created pipeline.
CreatePipelineRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

pipelineDisplayName

public final String pipelineDisplayName()

The display name of the pipeline.

Returns:

The display name of the pipeline.

pipelineDefinition

public final String pipelineDefinition()

The JSON pipeline definition of the pipeline.

Returns:

The JSON pipeline definition of the pipeline.

pipelineDefinitionS3Location

public final PipelineDefinitionS3Location pipelineDefinitionS3Location()

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

Returns:

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

pipelineDescription

public final String pipelineDescription()

A description of the pipeline.

Returns:

A description of the pipeline.

clientRequestToken

public final String clientRequestToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

Returns:

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

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

tags

public final List<Tag> tags()

A list of tags to apply to the created 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 to apply to the created pipeline.

parallelismConfiguration

public final ParallelismConfiguration parallelismConfiguration()

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

Returns:

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

toBuilder

public CreatePipelineRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreatePipelineRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePipelineRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo