Partilhar via


TaskInner Class

public final class TaskInner
extends Resource

The task that has the ARM resource and task properties. The task will have all information to schedule a run against it.

Constructor Summary

Constructor Description
TaskInner()

Creates an instance of TaskInner class.

Method Summary

Modifier and Type Method and Description
AgentProperties agentConfiguration()

Get the agentConfiguration property: The machine configuration of the run agent.

String agentPoolName()

Get the agentPoolName property: The dedicated agent pool for the task.

OffsetDateTime creationDate()

Get the creationDate property: The creation date of task.

Credentials credentials()

Get the credentials property: The properties that describes a set of credentials that will be used when this run is invoked.

static TaskInner fromJson(JsonReader jsonReader)

Reads an instance of TaskInner from the JsonReader.

String id()

Get the id property: Fully qualified resource Id for the resource.

IdentityProperties identity()

Get the identity property: Identity for the resource.

Boolean isSystemTask()

Get the isSystemTask property: The value of this property indicates whether the task resource is system task or not.

String logTemplate()

Get the logTemplate property: The template that describes the repository and tag information for run log artifact.

String name()

Get the name property: The name of the resource.

PlatformProperties platform()

Get the platform property: The platform properties against which the run has to happen.

ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the task.

TaskStatus status()

Get the status property: The current status of task.

TaskStepProperties step()

Get the step property: The properties of a task step.

SystemData systemData()

Get the systemData property: Metadata pertaining to creation and last modification of the resource.

Integer timeout()

Get the timeout property: Run timeout in seconds.

JsonWriter toJson(JsonWriter jsonWriter)
TriggerProperties trigger()

Get the trigger property: The properties that describe all triggers for the task.

String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

TaskInner withAgentConfiguration(AgentProperties agentConfiguration)

Set the agentConfiguration property: The machine configuration of the run agent.

TaskInner withAgentPoolName(String agentPoolName)

Set the agentPoolName property: The dedicated agent pool for the task.

TaskInner withCredentials(Credentials credentials)

Set the credentials property: The properties that describes a set of credentials that will be used when this run is invoked.

TaskInner withIdentity(IdentityProperties identity)

Set the identity property: Identity for the resource.

TaskInner withIsSystemTask(Boolean isSystemTask)

Set the isSystemTask property: The value of this property indicates whether the task resource is system task or not.

TaskInner withLocation(String location)
TaskInner withLogTemplate(String logTemplate)

Set the logTemplate property: The template that describes the repository and tag information for run log artifact.

TaskInner withPlatform(PlatformProperties platform)

Set the platform property: The platform properties against which the run has to happen.

TaskInner withStatus(TaskStatus status)

Set the status property: The current status of task.

TaskInner withStep(TaskStepProperties step)

Set the step property: The properties of a task step.

TaskInner withTags(Map<String,String> tags)
TaskInner withTimeout(Integer timeout)

Set the timeout property: Run timeout in seconds.

TaskInner withTrigger(TriggerProperties trigger)

Set the trigger property: The properties that describe all triggers for the task.

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

TaskInner

public TaskInner()

Creates an instance of TaskInner class.

Method Details

agentConfiguration

public AgentProperties agentConfiguration()

Get the agentConfiguration property: The machine configuration of the run agent.

Returns:

the agentConfiguration value.

agentPoolName

public String agentPoolName()

Get the agentPoolName property: The dedicated agent pool for the task.

Returns:

the agentPoolName value.

creationDate

public OffsetDateTime creationDate()

Get the creationDate property: The creation date of task.

Returns:

the creationDate value.

credentials

public Credentials credentials()

Get the credentials property: The properties that describes a set of credentials that will be used when this run is invoked.

Returns:

the credentials value.

fromJson

public static TaskInner fromJson(JsonReader jsonReader)

Reads an instance of TaskInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

TaskInner.id()

Returns:

the id value.

identity

public IdentityProperties identity()

Get the identity property: Identity for the resource.

Returns:

the identity value.

isSystemTask

public Boolean isSystemTask()

Get the isSystemTask property: The value of this property indicates whether the task resource is system task or not.

Returns:

the isSystemTask value.

logTemplate

public String logTemplate()

Get the logTemplate property: The template that describes the repository and tag information for run log artifact.

Returns:

the logTemplate value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

TaskInner.name()

Returns:

the name value.

platform

public PlatformProperties platform()

Get the platform property: The platform properties against which the run has to happen.

Returns:

the platform value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the task.

Returns:

the provisioningState value.

status

public TaskStatus status()

Get the status property: The current status of task.

Returns:

the status value.

step

public TaskStepProperties step()

Get the step property: The properties of a task step.

Returns:

the step value.

systemData

public SystemData systemData()

Get the systemData property: Metadata pertaining to creation and last modification of the resource.

Returns:

the systemData value.

timeout

public Integer timeout()

Get the timeout property: Run timeout in seconds.

Returns:

the timeout value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

TaskInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

trigger

public TriggerProperties trigger()

Get the trigger property: The properties that describe all triggers for the task.

Returns:

the trigger value.

type

public String type()

Get the type property: The type of the resource.

Overrides:

TaskInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAgentConfiguration

public TaskInner withAgentConfiguration(AgentProperties agentConfiguration)

Set the agentConfiguration property: The machine configuration of the run agent.

Parameters:

agentConfiguration - the agentConfiguration value to set.

Returns:

the TaskInner object itself.

withAgentPoolName

public TaskInner withAgentPoolName(String agentPoolName)

Set the agentPoolName property: The dedicated agent pool for the task.

Parameters:

agentPoolName - the agentPoolName value to set.

Returns:

the TaskInner object itself.

withCredentials

public TaskInner withCredentials(Credentials credentials)

Set the credentials property: The properties that describes a set of credentials that will be used when this run is invoked.

Parameters:

credentials - the credentials value to set.

Returns:

the TaskInner object itself.

withIdentity

public TaskInner withIdentity(IdentityProperties identity)

Set the identity property: Identity for the resource.

Parameters:

identity - the identity value to set.

Returns:

the TaskInner object itself.

withIsSystemTask

public TaskInner withIsSystemTask(Boolean isSystemTask)

Set the isSystemTask property: The value of this property indicates whether the task resource is system task or not.

Parameters:

isSystemTask - the isSystemTask value to set.

Returns:

the TaskInner object itself.

withLocation

public TaskInner withLocation(String location)

Overrides:

TaskInner.withLocation(String location)

Parameters:

location

withLogTemplate

public TaskInner withLogTemplate(String logTemplate)

Set the logTemplate property: The template that describes the repository and tag information for run log artifact.

Parameters:

logTemplate - the logTemplate value to set.

Returns:

the TaskInner object itself.

withPlatform

public TaskInner withPlatform(PlatformProperties platform)

Set the platform property: The platform properties against which the run has to happen.

Parameters:

platform - the platform value to set.

Returns:

the TaskInner object itself.

withStatus

public TaskInner withStatus(TaskStatus status)

Set the status property: The current status of task.

Parameters:

status - the status value to set.

Returns:

the TaskInner object itself.

withStep

public TaskInner withStep(TaskStepProperties step)

Set the step property: The properties of a task step.

Parameters:

step - the step value to set.

Returns:

the TaskInner object itself.

withTags

public TaskInner withTags(Map tags)

Overrides:

TaskInner.withTags(Map<String,String> tags)

Parameters:

tags

withTimeout

public TaskInner withTimeout(Integer timeout)

Set the timeout property: Run timeout in seconds.

Parameters:

timeout - the timeout value to set.

Returns:

the TaskInner object itself.

withTrigger

public TaskInner withTrigger(TriggerProperties trigger)

Set the trigger property: The properties that describe all triggers for the task.

Parameters:

trigger - the trigger value to set.

Returns:

the TaskInner object itself.

Applies to