Debian Codegraph @

docs/dyn/cloudtasks_v2beta3.projects.locations.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="cloudtasks_v2beta3.html">Cloud Tasks API</a> . <a href="cloudtasks_v2beta3.projects.html">projects</a> . <a href="cloudtasks_v2beta3.projects.locations.html">locations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="cloudtasks_v2beta3.projects.locations.queues.html">queues()</a></code>
79 </p>
80 <p class="firstline">Returns the queues Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84 <p class="firstline">Close httplib2 connections.</p>
85 <p class="toc_element">
86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
87 <p class="firstline">Gets information about a location.</p>
88 <p class="toc_element">
89 <code><a href="#getCmekConfig">getCmekConfig(name, x__xgafv=None)</a></code></p>
90 <p class="firstline">Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.</p>
91 <p class="toc_element">
92 <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
93 <p class="firstline">Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.</p>
94 <p class="toc_element">
95 <code><a href="#list_next">list_next()</a></code></p>
96 <p class="firstline">Retrieves the next page of results.</p>
97 <p class="toc_element">
98 <code><a href="#updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
99 <p class="firstline">Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.</p>
100 <h3>Method Details</h3>
101 <div class="method">
102 <code class="details" id="close">close()</code>
103 <pre>Close httplib2 connections.</pre>
104 </div>
105
106 <div class="method">
107 <code class="details" id="get">get(name, x__xgafv=None)</code>
108 <pre>Gets information about a location.
109
110 Args:
111 name: string, Resource name for the location. (required)
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117 Returns:
118 An object of the form:
119
120 { # A resource that represents a Google Cloud location.
121 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
122 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
123 &quot;a_key&quot;: &quot;A String&quot;,
124 },
125 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
126 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
127 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
128 },
129 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
130 }</pre>
131 </div>
132
133 <div class="method">
134 <code class="details" id="getCmekConfig">getCmekConfig(name, x__xgafv=None)</code>
135 <pre>Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.
136
137 Args:
138 name: string, Required. The config resource name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144 Returns:
145 An object of the form:
146
147 { # Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.
148 &quot;kmsKey&quot;: &quot;A String&quot;, # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues &amp; Tasks in the region. Setting this as blank will turn off CMEK encryption.
149 &quot;name&quot;: &quot;A String&quot;, # Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
150 }</pre>
151 </div>
152
153 <div class="method">
154 <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
155 <pre>Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
156
157 Args:
158 name: string, The resource that owns the locations collection, if applicable. (required)
159 extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
160 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `&quot;displayName=tokyo&quot;`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
161 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
162 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168 Returns:
169 An object of the form:
170
171 { # The response message for Locations.ListLocations.
172 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
173 { # A resource that represents a Google Cloud location.
174 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
175 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
176 &quot;a_key&quot;: &quot;A String&quot;,
177 },
178 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
179 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
180 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
181 },
182 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
183 },
184 ],
185 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
186 }</pre>
187 </div>
188
189 <div class="method">
190 <code class="details" id="list_next">list_next()</code>
191 <pre>Retrieves the next page of results.
192
193 Args:
194 previous_request: The request for the previous page. (required)
195 previous_response: The response from the request for the previous page. (required)
196
197 Returns:
198 A request object that you can call &#x27;execute()&#x27; on to request the next
199 page. Returns None if there are no more items in the collection.
200 </pre>
201 </div>
202
203 <div class="method">
204 <code class="details" id="updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
205 <pre>Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
206
207 Args:
208 name: string, Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
209 body: object, The request body.
210 The object takes the form of:
211
212 { # Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.
213 &quot;kmsKey&quot;: &quot;A String&quot;, # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues &amp; Tasks in the region. Setting this as blank will turn off CMEK encryption.
214 &quot;name&quot;: &quot;A String&quot;, # Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
215 }
216
217 updateMask: string, List of fields to be updated in this request.
218 x__xgafv: string, V1 error format.
219 Allowed values
220 1 - v1 error format
221 2 - v2 error format
222
223 Returns:
224 An object of the form:
225
226 { # Describes the customer-managed encryption key (CMEK) configuration associated with a project and location.
227 &quot;kmsKey&quot;: &quot;A String&quot;, # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues &amp; Tasks in the region. Setting this as blank will turn off CMEK encryption.
228 &quot;name&quot;: &quot;A String&quot;, # Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
229 }</pre>
230 </div>
231
232 </body></html>