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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="run_v1.html">Cloud Run Admin API</a> . <a href="run_v1.namespaces.html">namespaces</a> . <a href="run_v1.namespaces.domainmappings.html">domainmappings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, dryRun=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new domain mapping.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, apiVersion=None, dryRun=None, kind=None, propagationPolicy=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a domain mapping.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get information about a domain mapping.</p>
<p class="toc_element">
<code><a href="#list">list(parent, continue=None, fieldSelector=None, includeUninitialized=None, labelSelector=None, limit=None, resourceVersion=None, watch=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all domain mappings.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, dryRun=None, x__xgafv=None)</code>
<pre>Create a new domain mapping.
Args:
parent: string, Required. The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID (required)
body: object, The request body.
The object takes the form of:
{ # Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.
"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
"kind": "A String", # The kind of resource, in this case "DomainMapping".
"metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
"annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.
"a_key": "A String",
},
"clusterName": "A String", # Not supported by Cloud Run
"creationTimestamp": "A String", # UTC timestamp representing the server time when this object was created.
"deletionGracePeriodSeconds": 42, # Not supported by Cloud Run
"deletionTimestamp": "A String", # The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
"finalizers": [ # Not supported by Cloud Run
"A String",
],
"generateName": "A String", # Not supported by Cloud Run
"generation": 42, # A system-provided sequence number representing a specific generation of the desired state.
"labels": { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.
"a_key": "A String",
},
"name": "A String", # Required. The name of the resource. Name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.
"namespace": "A String", # Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
"ownerReferences": [ # Not supported by Cloud Run
{ # This is not supported or used by Cloud Run.
"apiVersion": "A String", # This is not supported or used by Cloud Run.
"blockOwnerDeletion": True or False, # This is not supported or used by Cloud Run.
"controller": True or False, # This is not supported or used by Cloud Run.
"kind": "A String", # This is not supported or used by Cloud Run.
"name": "A String", # This is not supported or used by Cloud Run.
"uid": "A String", # This is not supported or used by Cloud Run.
},
],
"resourceVersion": "A String", # Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
"selfLink": "A String", # URL representing this object.
"uid": "A String", # Unique, system-generated identifier for this resource.
},
"spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
"certificateMode": "A String", # The mode of the certificate.
"forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
"routeName": "A String", # The name of the Knative Route that this DomainMapping applies to. The route must exist.
},
"status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
"conditions": [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
{ # Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.
"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
"message": "A String", # Optional. Human readable message indicating details about the current status.
"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
"severity": "A String", # Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # type is used to communicate the status of the reconciliation process. Types common to all resources include: * "Ready" or "Completed": True when the Resource is ready.
},
],
"mappedRouteName": "A String", # The name of the route that the mapping currently points to.
"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.
"resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.
{ # A DNS resource record.
"name": "A String", # Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: 'www'.
"rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"type": "A String", # Resource record type. Example: `AAAA`.
},
],
"url": "A String", # Optional. Not supported by Cloud Run.
},
}
dryRun: string, Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.
"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
"kind": "A String", # The kind of resource, in this case "DomainMapping".
"metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
"annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.
"a_key": "A String",
},
"clusterName": "A String", # Not supported by Cloud Run
"creationTimestamp": "A String", # UTC timestamp representing the server time when this object was created.
"deletionGracePeriodSeconds": 42, # Not supported by Cloud Run
"deletionTimestamp": "A String", # The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
"finalizers": [ # Not supported by Cloud Run
"A String",
],
"generateName": "A String", # Not supported by Cloud Run
"generation": 42, # A system-provided sequence number representing a specific generation of the desired state.
"labels": { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.
"a_key": "A String",
},
"name": "A String", # Required. The name of the resource. Name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.
"namespace": "A String", # Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
"ownerReferences": [ # Not supported by Cloud Run
{ # This is not supported or used by Cloud Run.
"apiVersion": "A String", # This is not supported or used by Cloud Run.
"blockOwnerDeletion": True or False, # This is not supported or used by Cloud Run.
"controller": True or False, # This is not supported or used by Cloud Run.
"kind": "A String", # This is not supported or used by Cloud Run.
"name": "A String", # This is not supported or used by Cloud Run.
"uid": "A String", # This is not supported or used by Cloud Run.
},
],
"resourceVersion": "A String", # Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
"selfLink": "A String", # URL representing this object.
"uid": "A String", # Unique, system-generated identifier for this resource.
},
"spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
"certificateMode": "A String", # The mode of the certificate.
"forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
"routeName": "A String", # The name of the Knative Route that this DomainMapping applies to. The route must exist.
},
"status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
"conditions": [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
{ # Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.
"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
"message": "A String", # Optional. Human readable message indicating details about the current status.
"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
"severity": "A String", # Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # type is used to communicate the status of the reconciliation process. Types common to all resources include: * "Ready" or "Completed": True when the Resource is ready.
},
],
"mappedRouteName": "A String", # The name of the route that the mapping currently points to.
"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.
"resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.
{ # A DNS resource record.
"name": "A String", # Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: 'www'.
"rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"type": "A String", # Resource record type. Example: `AAAA`.
},
],
"url": "A String", # Optional. Not supported by Cloud Run.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, apiVersion=None, dryRun=None, kind=None, propagationPolicy=None, x__xgafv=None)</code>
<pre>Delete a domain mapping.
Args:
name: string, Required. The name of the domain mapping to delete. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID (required)
apiVersion: string, Cloud Run currently ignores this parameter.
dryRun: string, Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all`
kind: string, Cloud Run currently ignores this parameter.
propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Status is a return value for calls that don't return other objects.
"code": 42, # Suggested HTTP return code for this status, 0 if not set.
"details": { # StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. # Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
"causes": [ # The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
{ # StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
"field": "A String", # The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
"message": "A String", # A human-readable description of the cause of the error. This field may be presented as-is to a reader.
"reason": "A String", # A machine-readable description of the cause of the error. If this value is empty there is no information available.
},
],
"group": "A String", # The group attribute of the resource associated with the status StatusReason.
"kind": "A String", # The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind.
"name": "A String", # The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
"retryAfterSeconds": 42, # If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
"uid": "A String", # UID of the resource. (when there is a single resource which can be described).
},
"message": "A String", # A human-readable description of the status of this operation.
"metadata": { # Metadata for synthetic resources like List. In Cloud Run, all List Resources Responses will have a ListMeta instead of ObjectMeta. # Standard list metadata.
"continue": "A String", # Continuation token is a value emitted when the count of items is larger than the user/system limit. To retrieve the next page of items, pass the value of `continue` as the next request's `page_token`.
"resourceVersion": "A String", # Opaque string that identifies the server's internal version of this object. It can be used by clients to determine when objects have changed. If the message is passed back to the server, it must be left unmodified.
"selfLink": "A String", # URL representing this object.
},
"reason": "A String", # A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
"status": "A String", # Status of the operation. One of: "Success" or "Failure".
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get information about a domain mapping.
Args:
name: string, Required. The name of the domain mapping to retrieve. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.
"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
"kind": "A String", # The kind of resource, in this case "DomainMapping".
"metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
"annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.
"a_key": "A String",
},
"clusterName": "A String", # Not supported by Cloud Run
"creationTimestamp": "A String", # UTC timestamp representing the server time when this object was created.
"deletionGracePeriodSeconds": 42, # Not supported by Cloud Run
"deletionTimestamp": "A String", # The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
"finalizers": [ # Not supported by Cloud Run
"A String",
],
"generateName": "A String", # Not supported by Cloud Run
"generation": 42, # A system-provided sequence number representing a specific generation of the desired state.
"labels": { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.
"a_key": "A String",
},
"name": "A String", # Required. The name of the resource. Name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.
"namespace": "A String", # Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
"ownerReferences": [ # Not supported by Cloud Run
{ # This is not supported or used by Cloud Run.
"apiVersion": "A String", # This is not supported or used by Cloud Run.
"blockOwnerDeletion": True or False, # This is not supported or used by Cloud Run.
"controller": True or False, # This is not supported or used by Cloud Run.
"kind": "A String", # This is not supported or used by Cloud Run.
"name": "A String", # This is not supported or used by Cloud Run.
"uid": "A String", # This is not supported or used by Cloud Run.
},
],
"resourceVersion": "A String", # Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
"selfLink": "A String", # URL representing this object.
"uid": "A String", # Unique, system-generated identifier for this resource.
},
"spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
"certificateMode": "A String", # The mode of the certificate.
"forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
"routeName": "A String", # The name of the Knative Route that this DomainMapping applies to. The route must exist.
},
"status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
"conditions": [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
{ # Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.
"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
"message": "A String", # Optional. Human readable message indicating details about the current status.
"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
"severity": "A String", # Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # type is used to communicate the status of the reconciliation process. Types common to all resources include: * "Ready" or "Completed": True when the Resource is ready.
},
],
"mappedRouteName": "A String", # The name of the route that the mapping currently points to.
"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.
"resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.
{ # A DNS resource record.
"name": "A String", # Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: 'www'.
"rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"type": "A String", # Resource record type. Example: `AAAA`.
},
],
"url": "A String", # Optional. Not supported by Cloud Run.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, continue=None, fieldSelector=None, includeUninitialized=None, labelSelector=None, limit=None, resourceVersion=None, watch=None, x__xgafv=None)</code>
<pre>List all domain mappings.
Args:
parent: string, Required. The namespace from which the domain mappings should be listed. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID (required)
continue: string, Optional. Encoded string to continue paging.
fieldSelector: string, Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.
includeUninitialized: boolean, Not currently used by Cloud Run.
labelSelector: string, Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.
limit: integer, Optional. The maximum number of records that should be returned.
resourceVersion: string, The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.
watch: boolean, Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ListDomainMappingsResponse is a list of DomainMapping resources.
"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
"items": [ # List of DomainMappings.
{ # Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.
"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".
"kind": "A String", # The kind of resource, in this case "DomainMapping".
"metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate.
"annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.
"a_key": "A String",
},
"clusterName": "A String", # Not supported by Cloud Run
"creationTimestamp": "A String", # UTC timestamp representing the server time when this object was created.
"deletionGracePeriodSeconds": 42, # Not supported by Cloud Run
"deletionTimestamp": "A String", # The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
"finalizers": [ # Not supported by Cloud Run
"A String",
],
"generateName": "A String", # Not supported by Cloud Run
"generation": 42, # A system-provided sequence number representing a specific generation of the desired state.
"labels": { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.
"a_key": "A String",
},
"name": "A String", # Required. The name of the resource. Name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.
"namespace": "A String", # Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
"ownerReferences": [ # Not supported by Cloud Run
{ # This is not supported or used by Cloud Run.
"apiVersion": "A String", # This is not supported or used by Cloud Run.
"blockOwnerDeletion": True or False, # This is not supported or used by Cloud Run.
"controller": True or False, # This is not supported or used by Cloud Run.
"kind": "A String", # This is not supported or used by Cloud Run.
"name": "A String", # This is not supported or used by Cloud Run.
"uid": "A String", # This is not supported or used by Cloud Run.
},
],
"resourceVersion": "A String", # Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
"selfLink": "A String", # URL representing this object.
"uid": "A String", # Unique, system-generated identifier for this resource.
},
"spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.
"certificateMode": "A String", # The mode of the certificate.
"forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
"routeName": "A String", # The name of the Knative Route that this DomainMapping applies to. The route must exist.
},
"status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.
"conditions": [ # Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
{ # Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.
"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
"message": "A String", # Optional. Human readable message indicating details about the current status.
"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
"severity": "A String", # Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # type is used to communicate the status of the reconciliation process. Types common to all resources include: * "Ready" or "Completed": True when the Resource is ready.
},
],
"mappedRouteName": "A String", # The name of the route that the mapping currently points to.
"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.
"resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.
{ # A DNS resource record.
"name": "A String", # Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: 'www'.
"rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"type": "A String", # Resource record type. Example: `AAAA`.
},
],
"url": "A String", # Optional. Not supported by Cloud Run.
},
},
],
"kind": "A String", # The kind of this resource, in this case "DomainMappingList".
"metadata": { # Metadata for synthetic resources like List. In Cloud Run, all List Resources Responses will have a ListMeta instead of ObjectMeta. # Metadata associated with this DomainMapping list.
"continue": "A String", # Continuation token is a value emitted when the count of items is larger than the user/system limit. To retrieve the next page of items, pass the value of `continue` as the next request's `page_token`.
"resourceVersion": "A String", # Opaque string that identifies the server's internal version of this object. It can be used by clients to determine when objects have changed. If the message is passed back to the server, it must be left unmodified.
"selfLink": "A String", # URL representing this object.
},
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
</body></html>
|
