Get-OCIDatacatalogJobsList

SYNOPSIS

Invokes DataCatalog service - ListJobs operation.

SYNTAX

Limit

Get-OCIDatacatalogJobsList -CatalogId <String> [-DisplayName <String>] [-DisplayNameContains <String>] [-LifecycleState <JobLifecycleState>] [-TimeCreated <DateTime>] [-TimeUpdated <DateTime>] [-CreatedById <String>] [-UpdatedById <String>] [-JobType <JobType>] [-JobDefinitionKey <String>] [-DataAssetKey <String>] [-GlossaryKey <String>] [-ScheduleCronExpression <String>] [-TimeScheduleBegin <DateTime>] [-TimeScheduleEnd <DateTime>] [-ScheduleType <JobScheduleType>] [-ConnectionKey <String>] [-Fields <System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListJobsRequest+FieldsEnum]>] [-ExecutionCount <Int32>] [-TimeOfLatestExecution <DateTime>] [-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-OCIDatacatalogJobsList -CatalogId <String> [-DisplayName <String>] [-DisplayNameContains <String>] [-LifecycleState <JobLifecycleState>] [-TimeCreated <DateTime>] [-TimeUpdated <DateTime>] [-CreatedById <String>] [-UpdatedById <String>] [-JobType <JobType>] [-JobDefinitionKey <String>] [-DataAssetKey <String>] [-GlossaryKey <String>] [-ScheduleCronExpression <String>] [-TimeScheduleBegin <DateTime>] [-TimeScheduleEnd <DateTime>] [-ScheduleType <JobScheduleType>] [-ConnectionKey <String>] [-Fields <System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListJobsRequest+FieldsEnum]>] [-ExecutionCount <Int32>] [-TimeOfLatestExecution <DateTime>] [-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 jobs within a data catalog.

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

-ConnectionKey

Unique connection key.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

-DataAssetKey

Unique data asset key.

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

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

-DisplayName

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

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

-DisplayNameContains

A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

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

-ExecutionCount

The total number of executions for this job schedule.

Type: Int32
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 summary response.

Type: System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListJobsRequest+FieldsEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Key, DisplayName, Description, CatalogId, JobDefinitionKey, LifecycleState, TimeCreated, TimeUpdated, CreatedById, UpdatedById, JobType, ScheduleCronExpression, TimeScheduleBegin, ScheduleType, ExecutionCount, TimeOfLatestExecution, Executions, Uri, JobDefinitionName, ErrorCode, ErrorMessage

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

-GlossaryKey

Unique glossary key.

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

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

-JobDefinitionKey

Unique job definition key.

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

Required: False
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 lifecycle state.

Type: JobLifecycleState
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Active, Inactive, Expired

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

-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

-ScheduleCronExpression

Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

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

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

-ScheduleType

Type of the job schedule.

Type: JobScheduleType
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Scheduled, Immediate

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. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

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

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

-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

-TimeOfLatestExecution

The date and time the most recent execution for this job ,in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`

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

-TimeScheduleBegin

Date that the schedule should be operational. 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

-TimeScheduleEnd

Date that the schedule should end from being operational. 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.JobCollection
• Oci.DatacatalogService.Responses.ListJobsResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples