RunProperties Class

Package:

com.azure.resourcemanager.containerregistry.fluent.models

Maven Artifact:

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

• java.lang.Object
• • com.azure.resourcemanager.containerregistry.fluent.models.RunProperties

Implements

JsonSerializable<RunProperties>

public final class RunProperties
implements JsonSerializable<RunProperties>

The properties for a run.

Constructor Summary

Constructor	Description
RunProperties()	Creates an instance of RunProperties 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 run.
OffsetDateTime	createTime() Get the createTime property: The time the run was scheduled.
List<String>	customRegistries() Get the customRegistries property: The list of custom registries that were logged in during this run.
OffsetDateTime	finishTime() Get the finishTime property: The time the run finished.
static RunProperties	fromJson(JsonReader jsonReader) Reads an instance of RunProperties from the JsonReader.
ImageUpdateTrigger	imageUpdateTrigger() Get the imageUpdateTrigger property: The image update trigger that caused the run.
Boolean	isArchiveEnabled() Get the isArchiveEnabled property: The value that indicates whether archiving is enabled or not.
OffsetDateTime	lastUpdatedTime() Get the lastUpdatedTime property: The last updated time for the run.
ImageDescriptor	logArtifact() Get the logArtifact property: The image description for the log artifact.
List<ImageDescriptor>	outputImages() Get the outputImages property: The list of all images that were generated from the run.
PlatformProperties	platform() Get the platform property: The platform properties against which the run will happen.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of a run.
String	runErrorMessage() Get the runErrorMessage property: The error message received from backend systems after the run is scheduled.
String	runId() Get the runId property: The unique identifier for the run.
RunType	runType() Get the runType property: The type of run.
String	sourceRegistryAuth() Get the sourceRegistryAuth property: The scope of the credentials that were used to login to the source registry during this run.
SourceTriggerDescriptor	sourceTrigger() Get the sourceTrigger property: The source trigger that caused the run.
OffsetDateTime	startTime() Get the startTime property: The time the run started.
RunStatus	status() Get the status property: The current status of the run.
String	task() Get the task property: The task against which run was scheduled.
TimerTriggerDescriptor	timerTrigger() Get the timerTrigger property: The timer trigger that caused the run.
JsonWriter	toJson(JsonWriter jsonWriter)
String	updateTriggerToken() Get the updateTriggerToken property: The update trigger token passed for the Run.
void	validate() Validates the instance.
RunProperties	withAgentConfiguration(AgentProperties agentConfiguration) Set the agentConfiguration property: The machine configuration of the run agent.
RunProperties	withAgentPoolName(String agentPoolName) Set the agentPoolName property: The dedicated agent pool for the run.
RunProperties	withCreateTime(OffsetDateTime createTime) Set the createTime property: The time the run was scheduled.
RunProperties	withCustomRegistries(List<String> customRegistries) Set the customRegistries property: The list of custom registries that were logged in during this run.
RunProperties	withFinishTime(OffsetDateTime finishTime) Set the finishTime property: The time the run finished.
RunProperties	withImageUpdateTrigger(ImageUpdateTrigger imageUpdateTrigger) Set the imageUpdateTrigger property: The image update trigger that caused the run.
RunProperties	withIsArchiveEnabled(Boolean isArchiveEnabled) Set the isArchiveEnabled property: The value that indicates whether archiving is enabled or not.
RunProperties	withLastUpdatedTime(OffsetDateTime lastUpdatedTime) Set the lastUpdatedTime property: The last updated time for the run.
RunProperties	withOutputImages(List<ImageDescriptor> outputImages) Set the outputImages property: The list of all images that were generated from the run.
RunProperties	withPlatform(PlatformProperties platform) Set the platform property: The platform properties against which the run will happen.
RunProperties	withProvisioningState(ProvisioningState provisioningState) Set the provisioningState property: The provisioning state of a run.
RunProperties	withRunId(String runId) Set the runId property: The unique identifier for the run.
RunProperties	withRunType(RunType runType) Set the runType property: The type of run.
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.
RunProperties	withSourceTrigger(SourceTriggerDescriptor sourceTrigger) Set the sourceTrigger property: The source trigger that caused the run.
RunProperties	withStartTime(OffsetDateTime startTime) Set the startTime property: The time the run started.
RunProperties	withStatus(RunStatus status) Set the status property: The current status of the run.
RunProperties	withTask(String task) Set the task property: The task against which run was scheduled.
RunProperties	withTimerTrigger(TimerTriggerDescriptor timerTrigger) Set the timerTrigger property: The timer trigger that caused the run.
RunProperties	withUpdateTriggerToken(String updateTriggerToken) Set the updateTriggerToken property: The update trigger token passed for the Run.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RunProperties

public RunProperties()

Creates an instance of RunProperties 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 run.

Returns:

the agentPoolName value.

createTime

public OffsetDateTime createTime()

Get the createTime property: The time the run was scheduled.

Returns:

the createTime value.

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.

finishTime

public OffsetDateTime finishTime()

Get the finishTime property: The time the run finished.

Returns:

the finishTime value.

fromJson

public static RunProperties fromJson(JsonReader jsonReader)

Reads an instance of RunProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

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.

isArchiveEnabled

public Boolean isArchiveEnabled()

Get the isArchiveEnabled property: The value that indicates whether archiving is enabled or not.

Returns:

the isArchiveEnabled value.

lastUpdatedTime

public OffsetDateTime lastUpdatedTime()

Get the lastUpdatedTime property: The last updated time for the run.

Returns:

the lastUpdatedTime value.

logArtifact

public ImageDescriptor logArtifact()

Get the logArtifact property: The image description for the log artifact.

Returns:

the logArtifact value.

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.

platform

public PlatformProperties platform()

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

Returns:

the platform value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of a run.

Returns:

the provisioningState value.

runErrorMessage

public String runErrorMessage()

Get the runErrorMessage property: The error message received from backend systems after the run is scheduled.

Returns:

the runErrorMessage value.

runId

public String runId()

Get the runId property: The unique identifier for the run.

Returns:

the runId value.

runType

public RunType runType()

Get the runType property: The type of run.

Returns:

the runType value.

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.

sourceTrigger

public SourceTriggerDescriptor sourceTrigger()

Get the sourceTrigger property: The source trigger that caused the run.

Returns:

the sourceTrigger value.

startTime

public OffsetDateTime startTime()

Get the startTime property: The time the run started.

Returns:

the startTime value.

status

public RunStatus status()

Get the status property: The current status of the run.

Returns:

the status value.

task

public String task()

Get the task property: The task against which run was scheduled.

Returns:

the task value.

timerTrigger

public TimerTriggerDescriptor timerTrigger()

Get the timerTrigger property: The timer trigger that caused the run.

Returns:

the timerTrigger value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

updateTriggerToken

public String updateTriggerToken()

Get the updateTriggerToken property: The update trigger token passed for the Run.

Returns:

the updateTriggerToken value.

validate

public void validate()

Validates the instance.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.