Class RunProperties


  • public final class RunProperties
    extends Object
    The properties for a run.
    • Constructor Detail

      • RunProperties

        public RunProperties()
    • Method Detail

      • runId

        public String runId()
        Get the runId property: The unique identifier for the run.
        Returns:
        the runId value.
      • withRunId

        public RunProperties withRunId​(String runId)
        Set the runId property: The unique identifier for the run.
        Parameters:
        runId - the runId value to set.
        Returns:
        the RunProperties object itself.
      • status

        public RunStatus status()
        Get the status property: The current status of the run.
        Returns:
        the status value.
      • withStatus

        public RunProperties withStatus​(RunStatus status)
        Set the status property: The current status of the run.
        Parameters:
        status - the status value to set.
        Returns:
        the RunProperties object itself.
      • lastUpdatedTime

        public OffsetDateTime lastUpdatedTime()
        Get the lastUpdatedTime property: The last updated time for the run.
        Returns:
        the lastUpdatedTime value.
      • withLastUpdatedTime

        public RunProperties withLastUpdatedTime​(OffsetDateTime lastUpdatedTime)
        Set the lastUpdatedTime property: The last updated time for the run.
        Parameters:
        lastUpdatedTime - the lastUpdatedTime value to set.
        Returns:
        the RunProperties object itself.
      • runType

        public RunType runType()
        Get the runType property: The type of run.
        Returns:
        the runType value.
      • withRunType

        public RunProperties withRunType​(RunType runType)
        Set the runType property: The type of run.
        Parameters:
        runType - the runType value to set.
        Returns:
        the RunProperties object itself.
      • agentPoolName

        public String agentPoolName()
        Get the agentPoolName property: The dedicated agent pool for the run.
        Returns:
        the agentPoolName value.
      • withAgentPoolName

        public RunProperties withAgentPoolName​(String agentPoolName)
        Set the agentPoolName property: The dedicated agent pool for the run.
        Parameters:
        agentPoolName - the agentPoolName value to set.
        Returns:
        the RunProperties object itself.
      • createTime

        public OffsetDateTime createTime()
        Get the createTime property: The time the run was scheduled.
        Returns:
        the createTime value.
      • withCreateTime

        public RunProperties withCreateTime​(OffsetDateTime createTime)
        Set the createTime property: The time the run was scheduled.
        Parameters:
        createTime - the createTime value to set.
        Returns:
        the RunProperties object itself.
      • startTime

        public OffsetDateTime startTime()
        Get the startTime property: The time the run started.
        Returns:
        the startTime value.
      • withStartTime

        public RunProperties withStartTime​(OffsetDateTime startTime)
        Set the startTime property: The time the run started.
        Parameters:
        startTime - the startTime value to set.
        Returns:
        the RunProperties object itself.
      • finishTime

        public OffsetDateTime finishTime()
        Get the finishTime property: The time the run finished.
        Returns:
        the finishTime value.
      • withFinishTime

        public RunProperties withFinishTime​(OffsetDateTime finishTime)
        Set the finishTime property: The time the run finished.
        Parameters:
        finishTime - the finishTime value to set.
        Returns:
        the RunProperties object itself.
      • outputImages

        public List<ImageDescriptor> outputImages()
        Get the outputImages property: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies.
        Returns:
        the outputImages value.
      • withOutputImages

        public RunProperties withOutputImages​(List<ImageDescriptor> outputImages)
        Set the outputImages property: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies.
        Parameters:
        outputImages - the outputImages value to set.
        Returns:
        the RunProperties object itself.
      • task

        public String task()
        Get the task property: The task against which run was scheduled.
        Returns:
        the task value.
      • withTask

        public RunProperties withTask​(String task)
        Set the task property: The task against which run was scheduled.
        Parameters:
        task - the task value to set.
        Returns:
        the RunProperties object itself.
      • imageUpdateTrigger

        public ImageUpdateTrigger imageUpdateTrigger()
        Get the imageUpdateTrigger property: The image update trigger that caused the run. This is applicable if the task has base image trigger configured.
        Returns:
        the imageUpdateTrigger value.
      • withImageUpdateTrigger

        public RunProperties withImageUpdateTrigger​(ImageUpdateTrigger imageUpdateTrigger)
        Set the imageUpdateTrigger property: The image update trigger that caused the run. This is applicable if the task has base image trigger configured.
        Parameters:
        imageUpdateTrigger - the imageUpdateTrigger value to set.
        Returns:
        the RunProperties object itself.
      • sourceTrigger

        public SourceTriggerDescriptor sourceTrigger()
        Get the sourceTrigger property: The source trigger that caused the run.
        Returns:
        the sourceTrigger value.
      • withSourceTrigger

        public RunProperties withSourceTrigger​(SourceTriggerDescriptor sourceTrigger)
        Set the sourceTrigger property: The source trigger that caused the run.
        Parameters:
        sourceTrigger - the sourceTrigger value to set.
        Returns:
        the RunProperties object itself.
      • timerTrigger

        public TimerTriggerDescriptor timerTrigger()
        Get the timerTrigger property: The timer trigger that caused the run.
        Returns:
        the timerTrigger value.
      • withTimerTrigger

        public RunProperties withTimerTrigger​(TimerTriggerDescriptor timerTrigger)
        Set the timerTrigger property: The timer trigger that caused the run.
        Parameters:
        timerTrigger - the timerTrigger value to set.
        Returns:
        the RunProperties object itself.
      • platform

        public PlatformProperties platform()
        Get the platform property: The platform properties against which the run will happen.
        Returns:
        the platform value.
      • withPlatform

        public RunProperties withPlatform​(PlatformProperties platform)
        Set the platform property: The platform properties against which the run will happen.
        Parameters:
        platform - the platform value to set.
        Returns:
        the RunProperties object itself.
      • agentConfiguration

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

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

        public String sourceRegistryAuth()
        Get the sourceRegistryAuth property: The scope of the credentials that were used to login to the source registry during this run.
        Returns:
        the sourceRegistryAuth value.
      • withSourceRegistryAuth

        public RunProperties withSourceRegistryAuth​(String sourceRegistryAuth)
        Set the sourceRegistryAuth property: The scope of the credentials that were used to login to the source registry during this run.
        Parameters:
        sourceRegistryAuth - the sourceRegistryAuth value to set.
        Returns:
        the RunProperties object itself.
      • customRegistries

        public List<String> customRegistries()
        Get the customRegistries property: The list of custom registries that were logged in during this run.
        Returns:
        the customRegistries value.
      • withCustomRegistries

        public RunProperties withCustomRegistries​(List<String> customRegistries)
        Set the customRegistries property: The list of custom registries that were logged in during this run.
        Parameters:
        customRegistries - the customRegistries value to set.
        Returns:
        the RunProperties object itself.
      • runErrorMessage

        public String runErrorMessage()
        Get the runErrorMessage property: The error message received from backend systems after the run is scheduled.
        Returns:
        the runErrorMessage value.
      • updateTriggerToken

        public String updateTriggerToken()
        Get the updateTriggerToken property: The update trigger token passed for the Run.
        Returns:
        the updateTriggerToken value.
      • withUpdateTriggerToken

        public RunProperties withUpdateTriggerToken​(String updateTriggerToken)
        Set the updateTriggerToken property: The update trigger token passed for the Run.
        Parameters:
        updateTriggerToken - the updateTriggerToken value to set.
        Returns:
        the RunProperties object itself.
      • logArtifact

        public ImageDescriptor logArtifact()
        Get the logArtifact property: The image description for the log artifact.
        Returns:
        the logArtifact value.
      • provisioningState

        public ProvisioningState provisioningState()
        Get the provisioningState property: The provisioning state of a run.
        Returns:
        the provisioningState value.
      • withProvisioningState

        public RunProperties withProvisioningState​(ProvisioningState provisioningState)
        Set the provisioningState property: The provisioning state of a run.
        Parameters:
        provisioningState - the provisioningState value to set.
        Returns:
        the RunProperties object itself.
      • isArchiveEnabled

        public Boolean isArchiveEnabled()
        Get the isArchiveEnabled property: The value that indicates whether archiving is enabled or not.
        Returns:
        the isArchiveEnabled value.
      • withIsArchiveEnabled

        public RunProperties withIsArchiveEnabled​(Boolean isArchiveEnabled)
        Set the isArchiveEnabled property: The value that indicates whether archiving is enabled or not.
        Parameters:
        isArchiveEnabled - the isArchiveEnabled value to set.
        Returns:
        the RunProperties object itself.
      • validate

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