-
Notifications
You must be signed in to change notification settings - Fork 80
/
job_summary.go
117 lines (87 loc) · 5.38 KB
/
job_summary.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// Data Catalog API
//
// Use the Data Catalog APIs to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.
// For more information, see Data Catalog (https://docs.oracle.com/iaas/data-catalog/home.htm).
//
package datacatalog
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// JobSummary Details of a job. Jobs are scheduled instances of a job definition.
type JobSummary struct {
// Unique key of the job.
Key *string `mandatory:"true" json:"key"`
// URI to the job instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The data catalog's OCID.
CatalogId *string `mandatory:"false" json:"catalogId"`
// The unique key of the job definition resource that defined the scope of this job.
JobDefinitionKey *string `mandatory:"false" json:"jobDefinitionKey"`
// Lifecycle state of the job, such as running, paused, or completed.
LifecycleState JobLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Type of the job.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// Type of job schedule that is inferred from the scheduling properties.
ScheduleType *string `mandatory:"false" json:"scheduleType"`
// Detailed description of the job.
Description *string `mandatory:"false" json:"description"`
// The date and time the job was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Time that this job was last updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created this job.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated this job.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// 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.
ScheduleCronExpression *string `mandatory:"false" json:"scheduleCronExpression"`
// Date that the schedule should be operational. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeScheduleBegin *common.SDKTime `mandatory:"false" json:"timeScheduleBegin"`
// The total number of executions for this job schedule.
ExecutionCount *int `mandatory:"false" json:"executionCount"`
// The date and time of the most recent execution for this job, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeOfLatestExecution *common.SDKTime `mandatory:"false" json:"timeOfLatestExecution"`
// The display name of the job definition resource that defined the scope of this job.
JobDefinitionName *string `mandatory:"false" json:"jobDefinitionName"`
// Unique key of the data asset to which this job applies, if the job involves a data asset.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Unique key of the glossary to which this job applies.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.
ErrorCode *string `mandatory:"false" json:"errorCode"`
// Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
// Array of the executions summary associated with this job.
Executions []JobExecutionSummary `mandatory:"false" json:"executions"`
}
func (m JobSummary) String() string {
return common.PointerString(m)
}
// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m JobSummary) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingJobLifecycleStateEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetJobLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingJobTypeEnum(string(m.JobType)); !ok && m.JobType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for JobType: %s. Supported values are: %s.", m.JobType, strings.Join(GetJobTypeEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}