Get-OCIDatacatalogJobExecutionsList

SYNOPSIS

Invokes DataCatalog service - ListJobExecutions operation.

SYNTAX

Limit

Get-OCIDatacatalogJobExecutionsList -CatalogId <String> -JobKey <String> [-LifecycleState <JobExecutionState>] [-TimeCreated <DateTime>] [-TimeUpdated <DateTime>] [-CreatedById <String>] [-UpdatedById <String>] [-JobType <JobType>] [-SubType <String>] [-ParentKey <String>] [-TimeStart <DateTime>] [-TimeEnd <DateTime>] [-ErrorCode <String>] [-ErrorMessage <String>] [-ProcessKey <String>] [-ExternalUrl <String>] [-EventKey <String>] [-DataEntityKey <String>] [-Fields <System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListJobExecutionsRequest+FieldsEnum]>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-Limit <Int32>] [-Page <String>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIDatacatalogJobExecutionsList -CatalogId <String> -JobKey <String> [-LifecycleState <JobExecutionState>] [-TimeCreated <DateTime>] [-TimeUpdated <DateTime>] [-CreatedById <String>] [-UpdatedById <String>] [-JobType <JobType>] [-SubType <String>] [-ParentKey <String>] [-TimeStart <DateTime>] [-TimeEnd <DateTime>] [-ErrorCode <String>] [-ErrorMessage <String>] [-ProcessKey <String>] [-ExternalUrl <String>] [-EventKey <String>] [-DataEntityKey <String>] [-Fields <System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListJobExecutionsRequest+FieldsEnum]>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-Page <String>] [-OpcRequestId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Returns a list of job executions for a job.

PARAMETERS

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CatalogId

Unique catalog identifier.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigFile

The path to the config file.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CreatedById

OCID of the user who created the resource.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DataEntityKey

Unique entity key.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ErrorCode

Error code returned from the job execution or null if job is still running or didn't return an error.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ErrorMessage

Error message returned from the job execution or null if job is still running or didn't return an error.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-EventKey

Event that triggered the execution of this job or null.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ExternalUrl

The a URL of the job for accessing this resource and its status.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Fields

Specifies the fields to return in a job execution summary response.

Type: System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListJobExecutionsRequest+FieldsEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Key, JobKey, JobType, ParentKey, ScheduleInstanceKey, LifecycleState, TimeCreated, TimeStarted, TimeEnded, Uri

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-JobKey

Unique job key.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-JobType

Job type.

Type: JobType
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Harvest, Profiling, Sampling, Preview, Import, Export, ImportGlossary, ExportGlossary, Internal, Purge, Immediate, Scheduled, ImmediateExecution, ScheduledExecution, ScheduledExecutionInstance, AsyncDelete, ImportDataAsset, CreateScanProxy, AsyncExportGlossary, AsyncExportDataAsset

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LifecycleState

Job execution lifecycle state.

Type: JobExecutionState
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Created, InProgress, Inactive, Failed, Succeeded, Canceled, SucceededWithWarnings

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

The maximum number of items to return.

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OpcRequestId

The client request ID for tracing.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ParentKey

The unique key of the parent execution or null if this job execution has no parent.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ProcessKey

Process identifier related to the job execution.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortBy

The field to sort by. Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Timecreated

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortOrder

The sort order to use, either 'asc' or 'desc'.

Type: SortOrderEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SubType

Sub-type of this job execution.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeCreated

Time that the resource was created. An RFC3339 formatted datetime string.

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeEnd

Time that the job execution ended or null if the job is still running or hasn't run yet. An RFC3339 formatted datetime string.

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TimeStart

Time that the job execution was started or in the case of a future time, the time when the job will start. An RFC3339 formatted datetime string.

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeUpdated

Time that the resource was updated. An RFC3339 formatted datetime string.

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UpdatedById

OCID of the user who updated the resource.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

OUTPUTS

• Oci.DatacatalogService.Models.JobExecutionCollection
• Oci.DatacatalogService.Responses.ListJobExecutionsResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples