Class FileTaskRunRequest

java.lang.Object
com.azure.resourcemanager.containerregistry.models.RunRequest
com.azure.resourcemanager.containerregistry.models.FileTaskRunRequest
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunRequest>
public final class FileTaskRunRequest extends RunRequest
The request parameters for a scheduling run against a task file.

  • Constructor Details

    • FileTaskRunRequest

      public FileTaskRunRequest()
      Creates an instance of FileTaskRunRequest class.

  • Method Details

    • type

      public String type()
      Get the type property: The type of the run request.
      Overrides:
      type in class RunRequest
      Returns:
      the type value.

    • taskFilePath

      public String taskFilePath()
      Get the taskFilePath property: The template/definition file path relative to the source.
      Returns:
      the taskFilePath value.

    • withTaskFilePath

      public FileTaskRunRequest withTaskFilePath(String taskFilePath)
      Set the taskFilePath property: The template/definition file path relative to the source.
      Parameters:
      taskFilePath - the taskFilePath value to set.
      Returns:
      the FileTaskRunRequest object itself.

    • valuesFilePath

      public String valuesFilePath()
      Get the valuesFilePath property: The values/parameters file path relative to the source.
      Returns:
      the valuesFilePath value.

    • withValuesFilePath

      public FileTaskRunRequest withValuesFilePath(String valuesFilePath)
      Set the valuesFilePath property: The values/parameters file path relative to the source.
      Parameters:
      valuesFilePath - the valuesFilePath value to set.
      Returns:
      the FileTaskRunRequest object itself.

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

    • withValues

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

    • timeout

      public Integer timeout()
      Get the timeout property: Run timeout in seconds.
      Returns:
      the timeout value.

    • withTimeout

      public FileTaskRunRequest withTimeout(Integer timeout)
      Set the timeout property: Run timeout in seconds.
      Parameters:
      timeout - the timeout value to set.
      Returns:
      the FileTaskRunRequest object itself.

    • platform

      public PlatformProperties platform()
      Get the platform property: The platform properties against which the run has to happen.
      Returns:
      the platform value.

    • withPlatform

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

    • agentConfiguration

      public AgentProperties agentConfiguration()
      Get the agentConfiguration property: The machine configuration of the run agent.
      Returns:
      the agentConfiguration value.

    • withAgentConfiguration

      public FileTaskRunRequest withAgentConfiguration(AgentProperties agentConfiguration)
      Set the agentConfiguration property: The machine configuration of the run agent.
      Parameters:
      agentConfiguration - the agentConfiguration value to set.
      Returns:
      the FileTaskRunRequest object itself.

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

    • withSourceLocation

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

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

    • withCredentials

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

    • withIsArchiveEnabled

      public FileTaskRunRequest withIsArchiveEnabled(Boolean isArchiveEnabled)
      Set the isArchiveEnabled property: The value that indicates whether archiving is enabled for the run or not.
      Overrides:
      withIsArchiveEnabled in class RunRequest
      Parameters:
      isArchiveEnabled - the isArchiveEnabled value to set.
      Returns:
      the RunRequest object itself.

    • withAgentPoolName

      public FileTaskRunRequest withAgentPoolName(String agentPoolName)
      Set the agentPoolName property: The dedicated agent pool for the run.
      Overrides:
      withAgentPoolName in class RunRequest
      Parameters:
      agentPoolName - the agentPoolName value to set.
      Returns:
      the RunRequest object itself.

    • withLogTemplate

      public FileTaskRunRequest withLogTemplate(String logTemplate)
      Set the logTemplate property: The template that describes the repository and tag information for run log artifact.
      Overrides:
      withLogTemplate in class RunRequest
      Parameters:
      logTemplate - the logTemplate value to set.
      Returns:
      the RunRequest object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class RunRequest
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<RunRequest>
      Overrides:
      toJson in class RunRequest
      Throws:
      IOException

    • fromJson

      public static FileTaskRunRequest fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of FileTaskRunRequest from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of FileTaskRunRequest if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the FileTaskRunRequest.