ParameterString: Workflow ParameterString class

In DyfanJones/sagemaker-r-workflow: sagemaker pipeline and workflows

Workflow ParameterString class

Description

Pipeline string parameter for workflow.

Super classes

sagemaker.workflow::Entity -> sagemaker.workflow::Parameter -> ParameterString

Public fields

enum_values

Placeholder

Active bindings

str

Return default value or implicit value

Methods

Public methods

• ParameterString$new()

• ParameterString$to_request()

• ParameterString$clone()

Inherited methods

• sagemaker.workflow::Entity$format()

---

Method new()

Create a pipeline string parameter.

Usage

ParameterString$new(name, default_value = NULL, enum_values = NULL)

Arguments

name

(str): The name of the parameter.

default_value

(str): The default Python value of the parameter.

enum_values

(list): placeholder

---

Method to_request()

Get the request structure for workflow service calls.

Usage

ParameterString$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ParameterString$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-workflow documentation built on April 3, 2022, 11:28 p.m.