Partager via


FileTaskStep Class

public final class FileTaskStep
extends TaskStepProperties

The properties of a task step.

Constructor Summary

Constructor Description
FileTaskStep()

Creates an instance of FileTaskStep class.

Method Summary

Modifier and Type Method and Description
static FileTaskStep fromJson(JsonReader jsonReader)

Reads an instance of FileTaskStep from the JsonReader.

String taskFilePath()

Get the taskFilePath property: The task template/definition file path relative to the source context.

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.

String valuesFilePath()

Get the valuesFilePath property: The task values/parameters file path relative to the source context.

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

FileTaskStep withContextPath(String contextPath)

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

FileTaskStep withTaskFilePath(String taskFilePath)

Set the taskFilePath property: The task template/definition file path relative to the source context.

FileTaskStep withValues(List<SetValue> values)

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

FileTaskStep withValuesFilePath(String valuesFilePath)

Set the valuesFilePath property: The task values/parameters file path relative to the source context.

Methods inherited from TaskStepProperties

Methods inherited from java.lang.Object

Constructor Details

FileTaskStep

public FileTaskStep()

Creates an instance of FileTaskStep class.

Method Details

fromJson

public static FileTaskStep fromJson(JsonReader jsonReader)

Reads an instance of FileTaskStep from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FileTaskStep 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.

taskFilePath

public String taskFilePath()

Get the taskFilePath property: The task template/definition file path relative to the source context.

Returns:

the taskFilePath value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

FileTaskStep.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public StepType type()

Get the type property: The type of the step.

Overrides:

FileTaskStep.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

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

valuesFilePath

public String valuesFilePath()

Get the valuesFilePath property: The task values/parameters file path relative to the source context.

Returns:

the valuesFilePath value.

withContextAccessToken

public FileTaskStep 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:

FileTaskStep.withContextAccessToken(String contextAccessToken)

Parameters:

contextAccessToken

withContextPath

public FileTaskStep withContextPath(String contextPath)

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

Overrides:

FileTaskStep.withContextPath(String contextPath)

Parameters:

contextPath

withTaskFilePath

public FileTaskStep withTaskFilePath(String taskFilePath)

Set the taskFilePath property: The task template/definition file path relative to the source context.

Parameters:

taskFilePath - the taskFilePath value to set.

Returns:

the FileTaskStep object itself.

withValues

public FileTaskStep 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 FileTaskStep object itself.

withValuesFilePath

public FileTaskStep withValuesFilePath(String valuesFilePath)

Set the valuesFilePath property: The task values/parameters file path relative to the source context.

Parameters:

valuesFilePath - the valuesFilePath value to set.

Returns:

the FileTaskStep object itself.

Applies to