1# Copyright 2020 Google LLC
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15apiVersion: apiextensions.k8s.io/v1
16kind: CustomResourceDefinition
17metadata:
18 annotations:
19 cnrm.cloud.google.com/version: 1.106.0
20 creationTimestamp: null
21 labels:
22 cnrm.cloud.google.com/managed-by-kcc: "true"
23 cnrm.cloud.google.com/stability-level: alpha
24 cnrm.cloud.google.com/system: "true"
25 cnrm.cloud.google.com/tf2crd: "true"
26 name: bigquerydatatransferconfigs.bigquerydatatransfer.cnrm.cloud.google.com
27spec:
28 group: bigquerydatatransfer.cnrm.cloud.google.com
29 names:
30 categories:
31 - gcp
32 kind: BigQueryDataTransferConfig
33 plural: bigquerydatatransferconfigs
34 shortNames:
35 - gcpbigquerydatatransferconfig
36 - gcpbigquerydatatransferconfigs
37 singular: bigquerydatatransferconfig
38 scope: Namespaced
39 versions:
40 - additionalPrinterColumns:
41 - jsonPath: .metadata.creationTimestamp
42 name: Age
43 type: date
44 - description: When 'True', the most recent reconcile of the resource succeeded
45 jsonPath: .status.conditions[?(@.type=='Ready')].status
46 name: Ready
47 type: string
48 - description: The reason for the value in 'Ready'
49 jsonPath: .status.conditions[?(@.type=='Ready')].reason
50 name: Status
51 type: string
52 - description: The last transition time for the value in 'Status'
53 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
54 name: Status Age
55 type: date
56 name: v1alpha1
57 schema:
58 openAPIV3Schema:
59 properties:
60 apiVersion:
61 description: 'apiVersion defines the versioned schema of this representation
62 of an object. Servers should convert recognized schemas to the latest
63 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
64 type: string
65 kind:
66 description: 'kind is a string value representing the REST resource this
67 object represents. Servers may infer this from the endpoint the client
68 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
69 type: string
70 metadata:
71 type: object
72 spec:
73 properties:
74 dataRefreshWindowDays:
75 description: |-
76 The number of days to look back to automatically refresh the data.
77 For example, if dataRefreshWindowDays = 10, then every day BigQuery
78 reingests data for [today-10, today-1], rather than ingesting data for
79 just [today-1]. Only valid if the data source supports the feature.
80 Set the value to 0 to use the default value.
81 type: integer
82 dataSourceId:
83 description: Immutable. The data source id. Cannot be changed once
84 the transfer config is created.
85 type: string
86 destinationDatasetId:
87 description: The BigQuery target dataset id.
88 type: string
89 disabled:
90 description: When set to true, no runs are scheduled for a given transfer.
91 type: boolean
92 displayName:
93 description: The user specified display name for the transfer config.
94 type: string
95 emailPreferences:
96 description: |-
97 Email notifications will be sent according to these preferences to the
98 email address of the user who owns this transfer config.
99 properties:
100 enableFailureEmail:
101 description: If true, email notifications will be sent on transfer
102 run failures.
103 type: boolean
104 required:
105 - enableFailureEmail
106 type: object
107 location:
108 description: |-
109 Immutable. The geographic location where the transfer config should reside.
110 Examples: US, EU, asia-northeast1. The default value is US.
111 type: string
112 notificationPubsubTopic:
113 description: |-
114 Pub/Sub topic where notifications will be sent after transfer runs
115 associated with this transfer config finish.
116 type: string
117 params:
118 additionalProperties:
119 type: string
120 type: object
121 projectRef:
122 description: The project that this resource belongs to.
123 oneOf:
124 - not:
125 required:
126 - external
127 required:
128 - name
129 - not:
130 anyOf:
131 - required:
132 - name
133 - required:
134 - namespace
135 required:
136 - external
137 properties:
138 external:
139 description: 'Allowed value: The `name` field of a `Project` resource.'
140 type: string
141 name:
142 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
143 type: string
144 namespace:
145 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
146 type: string
147 type: object
148 resourceID:
149 description: Immutable. Optional. The service-generated name of the
150 resource. Used for acquisition only. Leave unset to create a new
151 resource.
152 type: string
153 schedule:
154 description: |-
155 Data transfer schedule. If the data source does not support a custom
156 schedule, this should be empty. If it is empty, the default value for
157 the data source will be used. The specified times are in UTC. Examples
158 of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,
159 jun 13:15, and first sunday of quarter 00:00. See more explanation
160 about the format here:
161 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
162 NOTE: the granularity should be at least 8 hours, or less frequent.
163 type: string
164 scheduleOptions:
165 description: Options customizing the data transfer schedule.
166 properties:
167 disableAutoScheduling:
168 description: |-
169 If true, automatic scheduling of data transfer runs for this
170 configuration will be disabled. The runs can be started on ad-hoc
171 basis using transferConfigs.startManualRuns API. When automatic
172 scheduling is disabled, the TransferConfig.schedule field will
173 be ignored.
174 type: boolean
175 endTime:
176 description: |-
177 Defines time to stop scheduling transfer runs. A transfer run cannot be
178 scheduled at or after the end time. The end time can be changed at any
179 moment. The time when a data transfer can be triggered manually is not
180 limited by this option.
181 type: string
182 startTime:
183 description: |-
184 Specifies time to start scheduling transfer runs. The first run will be
185 scheduled at or after the start time according to a recurrence pattern
186 defined in the schedule string. The start time can be changed at any
187 moment. The time when a data transfer can be triggered manually is not
188 limited by this option.
189 type: string
190 type: object
191 sensitiveParams:
192 description: |-
193 Different parameters are configured primarily using the the 'params' field on this
194 resource. This block contains the parameters which contain secrets or passwords so that they can be marked
195 sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key
196 in the 'params' map in the api request.
197
198 Credentials may not be specified in both locations and will cause an error. Changing from one location
199 to a different credential configuration in the config will require an apply to update state.
200 properties:
201 secretAccessKey:
202 description: The Secret Access Key of the AWS account transferring
203 data from.
204 oneOf:
205 - not:
206 required:
207 - valueFrom
208 required:
209 - value
210 - not:
211 required:
212 - value
213 required:
214 - valueFrom
215 properties:
216 value:
217 description: Value of the field. Cannot be used if 'valueFrom'
218 is specified.
219 type: string
220 valueFrom:
221 description: Source for the field's value. Cannot be used
222 if 'value' is specified.
223 properties:
224 secretKeyRef:
225 description: Reference to a value with the given key in
226 the given Secret in the resource's namespace.
227 properties:
228 key:
229 description: Key that identifies the value to be extracted.
230 type: string
231 name:
232 description: Name of the Secret to extract a value
233 from.
234 type: string
235 required:
236 - name
237 - key
238 type: object
239 type: object
240 type: object
241 required:
242 - secretAccessKey
243 type: object
244 serviceAccountName:
245 description: |-
246 Immutable. Service account email. If this field is set, transfer config will
247 be created with this service account credentials. It requires that
248 requesting user calling this API has permissions to act as this service account.
249 type: string
250 required:
251 - dataSourceId
252 - displayName
253 - params
254 - projectRef
255 type: object
256 status:
257 properties:
258 conditions:
259 description: Conditions represent the latest available observation
260 of the resource's current state.
261 items:
262 properties:
263 lastTransitionTime:
264 description: Last time the condition transitioned from one status
265 to another.
266 type: string
267 message:
268 description: Human-readable message indicating details about
269 last transition.
270 type: string
271 reason:
272 description: Unique, one-word, CamelCase reason for the condition's
273 last transition.
274 type: string
275 status:
276 description: Status is the status of the condition. Can be True,
277 False, Unknown.
278 type: string
279 type:
280 description: Type is the type of the condition.
281 type: string
282 type: object
283 type: array
284 name:
285 description: |-
286 The resource name of the transfer config. Transfer config names have the
287 form projects/{projectId}/locations/{location}/transferConfigs/{configId}.
288 Where configId is usually a uuid, but this is not required.
289 The name is ignored when creating a transfer config.
290 type: string
291 observedGeneration:
292 description: ObservedGeneration is the generation of the resource
293 that was most recently observed by the Config Connector controller.
294 If this is equal to metadata.generation, then that means that the
295 current reported status reflects the most recent desired state of
296 the resource.
297 type: integer
298 type: object
299 required:
300 - spec
301 type: object
302 served: true
303 storage: true
304 subresources:
305 status: {}
306status:
307 acceptedNames:
308 kind: ""
309 plural: ""
310 conditions: []
311 storedVersions: []
View as plain text