Share via


EncodedTaskStep Class

public final class EncodedTaskStep
extends TaskStepProperties

The properties of a encoded task step.

Constructor Summary

Constructor Description
EncodedTaskStep()

Creates an instance of EncodedTaskStep class.

Method Summary

Modifier and Type Method and Description
String encodedTaskContent()

Get the encodedTaskContent property: Base64 encoded value of the template/definition file content.

String encodedValuesContent()

Get the encodedValuesContent property: Base64 encoded value of the parameters/values file content.

static EncodedTaskStep fromJson(JsonReader jsonReader)

Reads an instance of EncodedTaskStep from the JsonReader.

JsonWriter toJson(JsonWriter jsonWriter)
StepType type()

Get the type property: The type of the step.

void validate()

Validates the instance.

List<SetValue> values()

Get the values property: The collection of overridable values that can be passed when running a task.

EncodedTaskStep withContextAccessToken(String contextAccessToken)

Set the contextAccessToken property: The token (git PAT or SAS token of storage account blob) associated with the context for a step.

EncodedTaskStep withContextPath(String contextPath)

Set the contextPath property: The URL(absolute or relative) of the source context for the task step.

EncodedTaskStep withEncodedTaskContent(String encodedTaskContent)

Set the encodedTaskContent property: Base64 encoded value of the template/definition file content.

EncodedTaskStep withEncodedValuesContent(String encodedValuesContent)

Set the encodedValuesContent property: Base64 encoded value of the parameters/values file content.

EncodedTaskStep withValues(List<SetValue> values)

Set the values property: The collection of overridable values that can be passed when running a task.

Methods inherited from TaskStepProperties

Methods inherited from java.lang.Object

Constructor Details

EncodedTaskStep

public EncodedTaskStep()

Creates an instance of EncodedTaskStep class.

Method Details

encodedTaskContent

public String encodedTaskContent()

Get the encodedTaskContent property: Base64 encoded value of the template/definition file content.

Returns:

the encodedTaskContent value.

encodedValuesContent

public String encodedValuesContent()

Get the encodedValuesContent property: Base64 encoded value of the parameters/values file content.

Returns:

the encodedValuesContent value.

fromJson

public static EncodedTaskStep fromJson(JsonReader jsonReader)

Reads an instance of EncodedTaskStep from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of EncodedTaskStep if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EncodedTaskStep.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public StepType type()

Get the type property: The type of the step.

Overrides:

EncodedTaskStep.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

EncodedTaskStep.validate()

values

public List<SetValue> values()

Get the values property: The collection of overridable values that can be passed when running a task.

Returns:

the values value.

withContextAccessToken

public EncodedTaskStep withContextAccessToken(String contextAccessToken)

Set the contextAccessToken property: The token (git PAT or SAS token of storage account blob) associated with the context for a step.

Overrides:

EncodedTaskStep.withContextAccessToken(String contextAccessToken)

Parameters:

contextAccessToken

withContextPath

public EncodedTaskStep withContextPath(String contextPath)

Set the contextPath property: The URL(absolute or relative) of the source context for the task step.

Overrides:

EncodedTaskStep.withContextPath(String contextPath)

Parameters:

contextPath

withEncodedTaskContent

public EncodedTaskStep withEncodedTaskContent(String encodedTaskContent)

Set the encodedTaskContent property: Base64 encoded value of the template/definition file content.

Parameters:

encodedTaskContent - the encodedTaskContent value to set.

Returns:

the EncodedTaskStep object itself.

withEncodedValuesContent

public EncodedTaskStep withEncodedValuesContent(String encodedValuesContent)

Set the encodedValuesContent property: Base64 encoded value of the parameters/values file content.

Parameters:

encodedValuesContent - the encodedValuesContent value to set.

Returns:

the EncodedTaskStep object itself.

withValues

public EncodedTaskStep withValues(List<SetValue> values)

Set the values property: The collection of overridable values that can be passed when running a task.

Parameters:

values - the values value to set.

Returns:

the EncodedTaskStep object itself.

Applies to