EncodedTaskRunRequest Class

Package:

com.azure.resourcemanager.containerregistry.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-containerregistry:2.55.1

• java.lang.Object
• • com.azure.resourcemanager.containerregistry.models.RunRequest
  • • com.azure.resourcemanager.containerregistry.models.EncodedTaskRunRequest

public final class EncodedTaskRunRequest
extends RunRequest

The parameters for a quick task run request.

Constructor Summary

Constructor	Description
EncodedTaskRunRequest()	Creates an instance of EncodedTaskRunRequest class.

Method Summary

Modifier and Type	Method and Description
AgentProperties	agentConfiguration() Get the agentConfiguration property: The machine configuration of the run agent.
Credentials	credentials() Get the credentials property: The properties that describes a set of credentials that will be used when this run is invoked.
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 EncodedTaskRunRequest	fromJson(JsonReader jsonReader) Reads an instance of EncodedTaskRunRequest from the JsonReader.
PlatformProperties	platform() Get the platform property: The platform properties against which the run has to happen.
String	sourceLocation() Get the sourceLocation property: The URL(absolute or relative) of the source context.
Integer	timeout() Get the timeout property: Run timeout in seconds.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the run request.
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.
EncodedTaskRunRequest	withAgentConfiguration(AgentProperties agentConfiguration) Set the agentConfiguration property: The machine configuration of the run agent.
EncodedTaskRunRequest	withAgentPoolName(String agentPoolName) Set the agentPoolName property: The dedicated agent pool for the run.
EncodedTaskRunRequest	withCredentials(Credentials credentials) Set the credentials property: The properties that describes a set of credentials that will be used when this run is invoked.
EncodedTaskRunRequest	withEncodedTaskContent(String encodedTaskContent) Set the encodedTaskContent property: Base64 encoded value of the template/definition file content.
EncodedTaskRunRequest	withEncodedValuesContent(String encodedValuesContent) Set the encodedValuesContent property: Base64 encoded value of the parameters/values file content.
EncodedTaskRunRequest	withIsArchiveEnabled(Boolean isArchiveEnabled) Set the isArchiveEnabled property: The value that indicates whether archiving is enabled for the run or not.
EncodedTaskRunRequest	withLogTemplate(String logTemplate) Set the logTemplate property: The template that describes the repository and tag information for run log artifact.
EncodedTaskRunRequest	withPlatform(PlatformProperties platform) Set the platform property: The platform properties against which the run has to happen.
EncodedTaskRunRequest	withSourceLocation(String sourceLocation) Set the sourceLocation property: The URL(absolute or relative) of the source context.
EncodedTaskRunRequest	withTimeout(Integer timeout) Set the timeout property: Run timeout in seconds.
EncodedTaskRunRequest	withValues(List<SetValue> values) Set the values property: The collection of overridable values that can be passed when running a task.

Methods inherited from RunRequest

agentPoolName fromJson isArchiveEnabled logTemplate toJson type validate withAgentPoolName withIsArchiveEnabled withLogTemplate

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EncodedTaskRunRequest

public EncodedTaskRunRequest()

Creates an instance of EncodedTaskRunRequest class.

Method Details

agentConfiguration

public AgentProperties agentConfiguration()

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

Returns:

the agentConfiguration 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.

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 EncodedTaskRunRequest fromJson(JsonReader jsonReader)

Reads an instance of EncodedTaskRunRequest from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

platform

public PlatformProperties platform()

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

Returns:

the platform value.

sourceLocation

public String sourceLocation()

Get the sourceLocation property: The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.

Returns:

the sourceLocation value.

timeout

public Integer timeout()

Get the timeout property: Run timeout in seconds.

Returns:

the timeout value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EncodedTaskRunRequest.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the run request.

Overrides:

EncodedTaskRunRequest.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

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

withAgentConfiguration

public EncodedTaskRunRequest withAgentConfiguration(AgentProperties agentConfiguration)

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

Parameters:

agentConfiguration - the agentConfiguration value to set.

Returns:

the EncodedTaskRunRequest object itself.

withAgentPoolName

public EncodedTaskRunRequest withAgentPoolName(String agentPoolName)

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

Overrides:

EncodedTaskRunRequest.withAgentPoolName(String agentPoolName)

Parameters:

agentPoolName

withCredentials

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

withEncodedTaskContent

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

withEncodedValuesContent

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

withIsArchiveEnabled

public EncodedTaskRunRequest withIsArchiveEnabled(Boolean isArchiveEnabled)

Set the isArchiveEnabled property: The value that indicates whether archiving is enabled for the run or not.

Overrides:

EncodedTaskRunRequest.withIsArchiveEnabled(Boolean isArchiveEnabled)

Parameters:

isArchiveEnabled

withLogTemplate

public EncodedTaskRunRequest withLogTemplate(String logTemplate)

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

Overrides:

EncodedTaskRunRequest.withLogTemplate(String logTemplate)

Parameters:

logTemplate

withPlatform

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

withSourceLocation

public EncodedTaskRunRequest withSourceLocation(String sourceLocation)

Set the sourceLocation property: The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.

Parameters:

sourceLocation - the sourceLocation value to set.

Returns:

the EncodedTaskRunRequest object itself.

withTimeout

public EncodedTaskRunRequest withTimeout(Integer timeout)

Set the timeout property: Run timeout in seconds.

Parameters:

timeout - the timeout value to set.

Returns:

the EncodedTaskRunRequest object itself.

withValues

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