Share via


FileTaskStepUpdateParameters Class

public final class FileTaskStepUpdateParameters
extends TaskStepUpdateParameters

The properties of updating a task step.

Constructor Summary

Constructor Description
FileTaskStepUpdateParameters()

Creates an instance of FileTaskStepUpdateParameters class.

Method Summary

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

Reads an instance of FileTaskStepUpdateParameters 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 values/parameters file path relative to the source context.

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

FileTaskStepUpdateParameters withContextPath(String contextPath)

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

FileTaskStepUpdateParameters withTaskFilePath(String taskFilePath)

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

FileTaskStepUpdateParameters withValues(List<SetValue> values)

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

FileTaskStepUpdateParameters withValuesFilePath(String valuesFilePath)

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

Methods inherited from TaskStepUpdateParameters

Methods inherited from java.lang.Object

Constructor Details

FileTaskStepUpdateParameters

public FileTaskStepUpdateParameters()

Creates an instance of FileTaskStepUpdateParameters class.

Method Details

fromJson

public static FileTaskStepUpdateParameters fromJson(JsonReader jsonReader)

Reads an instance of FileTaskStepUpdateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the FileTaskStepUpdateParameters.

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:

FileTaskStepUpdateParameters.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public StepType type()

Get the type property: The type of the step.

Overrides:

FileTaskStepUpdateParameters.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

FileTaskStepUpdateParameters.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 values/parameters file path relative to the source context.

Returns:

the valuesFilePath value.

withContextAccessToken

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

FileTaskStepUpdateParameters.withContextAccessToken(String contextAccessToken)

Parameters:

contextAccessToken

withContextPath

public FileTaskStepUpdateParameters withContextPath(String contextPath)

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

Overrides:

FileTaskStepUpdateParameters.withContextPath(String contextPath)

Parameters:

contextPath

withTaskFilePath

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

withValues

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

withValuesFilePath

public FileTaskStepUpdateParameters withValuesFilePath(String valuesFilePath)

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

Parameters:

valuesFilePath - the valuesFilePath value to set.

Returns:

the FileTaskStepUpdateParameters object itself.

Applies to