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
|
<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="eventarc_v1.html">Eventarc API</a> . <a href="eventarc_v1.projects.html">projects</a> . <a href="eventarc_v1.projects.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.channelConnections.html">channelConnections()</a></code>
</p>
<p class="firstline">Returns the channelConnections Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.channels.html">channels()</a></code>
</p>
<p class="firstline">Returns the channels Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.enrollments.html">enrollments()</a></code>
</p>
<p class="firstline">Returns the enrollments Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.googleApiSources.html">googleApiSources()</a></code>
</p>
<p class="firstline">Returns the googleApiSources Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.kafkaSources.html">kafkaSources()</a></code>
</p>
<p class="firstline">Returns the kafkaSources Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.messageBuses.html">messageBuses()</a></code>
</p>
<p class="firstline">Returns the messageBuses Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.pipelines.html">pipelines()</a></code>
</p>
<p class="firstline">Returns the pipelines Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.providers.html">providers()</a></code>
</p>
<p class="firstline">Returns the providers Resource.</p>
<p class="toc_element">
<code><a href="eventarc_v1.projects.locations.triggers.html">triggers()</a></code>
</p>
<p class="firstline">Returns the triggers Resource.</p>
<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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#getGoogleChannelConfig">getGoogleChannelConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about the supported locations for this service.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#updateGoogleChannelConfig">updateGoogleChannelConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a single GoogleChannelConfig</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="get">get(name, x__xgafv=None)</code>
<pre>Gets information about a location.
Args:
name: string, Resource name for the location. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource that represents a Google Cloud location.
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
"metadata": { # Service-specific metadata. For example the available capacity at the given location.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
}</pre>
</div>
<div class="method">
<code class="details" id="getGoogleChannelConfig">getGoogleChannelConfig(name, x__xgafv=None)</code>
<pre>Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.
Args:
name: string, Required. The name of the config to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
"cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Optional. Resource labels.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
"updateTime": "A String", # Output only. The last-modified time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists information about the supported locations for this service.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Locations.ListLocations.
"locations": [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents a Google Cloud location.
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
"metadata": { # Service-specific metadata. For example the available capacity at the given location.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
},
],
"nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="updateGoogleChannelConfig">updateGoogleChannelConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update a single GoogleChannelConfig
Args:
name: string, Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided. (required)
body: object, The request body.
The object takes the form of:
{ # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
"cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Optional. Resource labels.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
"updateTime": "A String", # Output only. The last-modified time.
}
updateMask: string, The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
"cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Optional. Resource labels.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
"updateTime": "A String", # Output only. The last-modified time.
}</pre>
</div>
</body></html>
|
