com.amazonaws.services.sagemaker.model

Class RenderUiTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.RenderUiTemplateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RenderUiTemplateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RenderUiTemplateRequest()

Method Summary

Modifier and Type	Method and Description
RenderUiTemplateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getHumanTaskUiArn() The HumanTaskUiArn of the worker UI that you want to render.
String	getRoleArn() The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
RenderableTask	getTask() A RenderableTask object containing a representative task to render.
UiTemplate	getUiTemplate() A Template object containing the worker UI template to render.
int	hashCode()
void	setHumanTaskUiArn(String humanTaskUiArn) The HumanTaskUiArn of the worker UI that you want to render.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
void	setTask(RenderableTask task) A RenderableTask object containing a representative task to render.
void	setUiTemplate(UiTemplate uiTemplate) A Template object containing the worker UI template to render.
String	toString() Returns a string representation of this object.
RenderUiTemplateRequest	withHumanTaskUiArn(String humanTaskUiArn) The HumanTaskUiArn of the worker UI that you want to render.
RenderUiTemplateRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
RenderUiTemplateRequest	withTask(RenderableTask task) A RenderableTask object containing a representative task to render.
RenderUiTemplateRequest	withUiTemplate(UiTemplate uiTemplate) A Template object containing the worker UI template to render.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RenderUiTemplateRequest

public RenderUiTemplateRequest()

Method Detail

setUiTemplate

public void setUiTemplate(UiTemplate uiTemplate)

A Template object containing the worker UI template to render.

Parameters:

uiTemplate - A Template object containing the worker UI template to render.

getUiTemplate

public UiTemplate getUiTemplate()

A Template object containing the worker UI template to render.

Returns:

A Template object containing the worker UI template to render.

withUiTemplate

public RenderUiTemplateRequest withUiTemplate(UiTemplate uiTemplate)

A Template object containing the worker UI template to render.

Parameters:

uiTemplate - A Template object containing the worker UI template to render.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTask

public void setTask(RenderableTask task)

A RenderableTask object containing a representative task to render.

Parameters:

task - A RenderableTask object containing a representative task to render.

getTask

public RenderableTask getTask()

A RenderableTask object containing a representative task to render.

Returns:

A RenderableTask object containing a representative task to render.

withTask

public RenderUiTemplateRequest withTask(RenderableTask task)

A RenderableTask object containing a representative task to render.

Parameters:

task - A RenderableTask object containing a representative task to render.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Parameters:

roleArn - The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Returns:

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

withRoleArn

public RenderUiTemplateRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Parameters:

roleArn - The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHumanTaskUiArn

public void setHumanTaskUiArn(String humanTaskUiArn)

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

Parameters:

humanTaskUiArn - The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

getHumanTaskUiArn

public String getHumanTaskUiArn()

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

Returns:

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

withHumanTaskUiArn

public RenderUiTemplateRequest withHumanTaskUiArn(String humanTaskUiArn)

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

Parameters:

humanTaskUiArn - The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RenderUiTemplateRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()