/
job_definition.go
128 lines (98 loc) · 6.52 KB
/
job_definition.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
118
119
120
121
122
123
124
125
126
127
128
// 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"
)
// JobDefinition Representation of a job definition resource. Job definitions define the harvest scope and includes the list
// of objects to be harvested along with a schedule. The list of objects is usually specified through a combination
// of object type, regular expressions, or specific names of objects and a sample size for the data harvested.
type JobDefinition struct {
// Unique key of the job definition resource that is immutable.
Key *string `mandatory:"true" json:"key"`
// 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"`
// Type of the job definition.
JobType JobTypeEnum `mandatory:"false" json:"jobType,omitempty"`
// Specifies if the job definition is incremental or full.
IsIncremental *bool `mandatory:"false" json:"isIncremental"`
// The key of the data asset for which the job is defined.
DataAssetKey *string `mandatory:"false" json:"dataAssetKey"`
// Unique key of the glossary to which this job applies.
GlossaryKey *string `mandatory:"false" json:"glossaryKey"`
// Detailed description of the job definition.
Description *string `mandatory:"false" json:"description"`
// The key of the default connection resource to be used for harvest, sampling, profiling jobs.
// This may be overridden in each job instance.
ConnectionKey *string `mandatory:"false" json:"connectionKey"`
// Version of the job definition object. Used internally but can be visible to users.
InternalVersion *string `mandatory:"false" json:"internalVersion"`
// Lifecycle state of the job definition.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the job definition 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"`
// The last time that any change was made to the data asset. 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 definition.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who updated this job definition.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// URI to the job definition instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Specify if sample data to be extracted as part of this harvest.
IsSampleDataExtracted *bool `mandatory:"false" json:"isSampleDataExtracted"`
// Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
SampleDataSizeInMBs *int `mandatory:"false" json:"sampleDataSizeInMBs"`
// Time that the latest job execution started. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeLatestExecutionStarted *common.SDKTime `mandatory:"false" json:"timeLatestExecutionStarted"`
// Time that the latest job execution ended or null if it hasn't yet completed.
// An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeLatestExecutionEnded *common.SDKTime `mandatory:"false" json:"timeLatestExecutionEnded"`
// Status of the latest job execution, such as running, paused, or completed.
JobExecutionState JobExecutionStateEnum `mandatory:"false" json:"jobExecutionState,omitempty"`
// Type of job schedule for the latest job executed.
ScheduleType JobScheduleTypeEnum `mandatory:"false" json:"scheduleType,omitempty"`
// A map of maps that contains the properties which are specific to the job type. Each job type
// definition may define it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// job definitions have required properties within the "default" category.
// Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
}
func (m JobDefinition) 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 JobDefinition) ValidateEnumValue() (bool, error) {
errMessage := []string{}
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 _, ok := GetMappingLifecycleStateEnum(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(GetLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingJobExecutionStateEnum(string(m.JobExecutionState)); !ok && m.JobExecutionState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for JobExecutionState: %s. Supported values are: %s.", m.JobExecutionState, strings.Join(GetJobExecutionStateEnumStringValues(), ",")))
}
if _, ok := GetMappingJobScheduleTypeEnum(string(m.ScheduleType)); !ok && m.ScheduleType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for ScheduleType: %s. Supported values are: %s.", m.ScheduleType, strings.Join(GetJobScheduleTypeEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}