Share via


JobRunProperties interface

Job run properties.

Properties

agentName

Name of the Agent assigned to this run.

agentResourceId

Fully qualified resource id of the Agent assigned to this run.

bytesExcluded

Bytes of data that will not be transferred, as they are excluded by user configuration.

bytesFailed

Bytes of data that were attempted to transfer and failed.

bytesNoTransferNeeded

Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).

bytesScanned

Bytes of data scanned so far in source.

bytesTransferred

Bytes of data successfully transferred to target.

bytesUnsupported

Bytes of data that will not be transferred, as they are unsupported on target.

error

Error details.

executionEndTime

End time of the run. Null if Agent has not reported that the job has ended.

executionStartTime

Start time of the run. Null if no Agent reported that the job has started.

itemsExcluded

Number of items that will not be transferred, as they are excluded by user configuration.

itemsFailed

Number of items that were attempted to transfer and failed.

itemsNoTransferNeeded

Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).

itemsScanned

Number of items scanned so far in source.

itemsTransferred

Number of items successfully transferred to target.

itemsUnsupported

Number of items that will not be transferred, as they are unsupported on target.

jobDefinitionProperties

Copy of parent Job Definition's properties at time of Job Run creation.

lastStatusUpdate

The last updated time of the Job Run.

provisioningState

The provisioning state of this resource.

scanStatus

The status of Agent's scanning of source.

sourceName

Name of source Endpoint resource. This resource may no longer exist.

sourceProperties

Copy of source Endpoint resource's properties at time of Job Run creation.

sourceResourceId

Fully qualified resource id of source Endpoint. This id may no longer exist.

status

The state of the job execution.

targetName

Name of target Endpoint resource. This resource may no longer exist.

targetProperties

Copy of Endpoint resource's properties at time of Job Run creation.

targetResourceId

Fully qualified resource id of of Endpoint. This id may no longer exist.

Property Details

agentName

Name of the Agent assigned to this run.

agentName?: string

Property Value

string

agentResourceId

Fully qualified resource id of the Agent assigned to this run.

agentResourceId?: string

Property Value

string

bytesExcluded

Bytes of data that will not be transferred, as they are excluded by user configuration.

bytesExcluded?: number

Property Value

number

bytesFailed

Bytes of data that were attempted to transfer and failed.

bytesFailed?: number

Property Value

number

bytesNoTransferNeeded

Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).

bytesNoTransferNeeded?: number

Property Value

number

bytesScanned

Bytes of data scanned so far in source.

bytesScanned?: number

Property Value

number

bytesTransferred

Bytes of data successfully transferred to target.

bytesTransferred?: number

Property Value

number

bytesUnsupported

Bytes of data that will not be transferred, as they are unsupported on target.

bytesUnsupported?: number

Property Value

number

error

Error details.

error?: JobRunError

Property Value

executionEndTime

End time of the run. Null if Agent has not reported that the job has ended.

executionEndTime?: Date

Property Value

Date

executionStartTime

Start time of the run. Null if no Agent reported that the job has started.

executionStartTime?: Date

Property Value

Date

itemsExcluded

Number of items that will not be transferred, as they are excluded by user configuration.

itemsExcluded?: number

Property Value

number

itemsFailed

Number of items that were attempted to transfer and failed.

itemsFailed?: number

Property Value

number

itemsNoTransferNeeded

Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).

itemsNoTransferNeeded?: number

Property Value

number

itemsScanned

Number of items scanned so far in source.

itemsScanned?: number

Property Value

number

itemsTransferred

Number of items successfully transferred to target.

itemsTransferred?: number

Property Value

number

itemsUnsupported

Number of items that will not be transferred, as they are unsupported on target.

itemsUnsupported?: number

Property Value

number

jobDefinitionProperties

Copy of parent Job Definition's properties at time of Job Run creation.

jobDefinitionProperties?: any

Property Value

any

lastStatusUpdate

The last updated time of the Job Run.

lastStatusUpdate?: Date

Property Value

Date

provisioningState

The provisioning state of this resource.

provisioningState?: string

Property Value

string

scanStatus

The status of Agent's scanning of source.

scanStatus?: string

Property Value

string

sourceName

Name of source Endpoint resource. This resource may no longer exist.

sourceName?: string

Property Value

string

sourceProperties

Copy of source Endpoint resource's properties at time of Job Run creation.

sourceProperties?: any

Property Value

any

sourceResourceId

Fully qualified resource id of source Endpoint. This id may no longer exist.

sourceResourceId?: string

Property Value

string

status

The state of the job execution.

status?: string

Property Value

string

targetName

Name of target Endpoint resource. This resource may no longer exist.

targetName?: string

Property Value

string

targetProperties

Copy of Endpoint resource's properties at time of Job Run creation.

targetProperties?: any

Property Value

any

targetResourceId

Fully qualified resource id of of Endpoint. This id may no longer exist.

targetResourceId?: string

Property Value

string