Skip to content

Commit 68574b0

Browse files
feat(cloudscheduler): update the api
#### cloudscheduler:v1 The following keys were added: - resources.projects.resources.locations.methods.getCmekConfig (Total Keys: 11) - resources.projects.resources.locations.methods.updateCmekConfig (Total Keys: 15) - schemas.CmekConfig (Total Keys: 4) #### cloudscheduler:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.cancel (Total Keys: 12) - resources.projects.resources.locations.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 20) - schemas.CancelOperationRequest (Total Keys: 2) - schemas.ListOperationsResponse (Total Keys: 7) - schemas.Operation (Total Keys: 9)
1 parent aa4d8af commit 68574b0

7 files changed

+672
-90
lines changed

docs/dyn/cloudscheduler_v1.projects.locations.html

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,18 @@ <h2>Instance Methods</h2>
9090
<p class="toc_element">
9191
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
9292
<p class="firstline">Gets information about a location.</p>
93+
<p class="toc_element">
94+
<code><a href="#getCmekConfig">getCmekConfig(name, x__xgafv=None)</a></code></p>
95+
<p class="firstline">Gets the Scheduler config in the project/region.</p>
9396
<p class="toc_element">
9497
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
9598
<p class="firstline">Lists information about the supported locations for this service.</p>
9699
<p class="toc_element">
97100
<code><a href="#list_next">list_next()</a></code></p>
98101
<p class="firstline">Retrieves the next page of results.</p>
102+
<p class="toc_element">
103+
<code><a href="#updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
104+
<p class="firstline">Initializes or Updates the a scheduler config.</p>
99105
<h3>Method Details</h3>
100106
<div class="method">
101107
<code class="details" id="close">close()</code>
@@ -129,13 +135,33 @@ <h3>Method Details</h3>
129135
}</pre>
130136
</div>
131137

138+
<div class="method">
139+
<code class="details" id="getCmekConfig">getCmekConfig(name, x__xgafv=None)</code>
140+
<pre>Gets the Scheduler config in the project/region.
141+
142+
Args:
143+
name: string, Required. The config name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig (required)
144+
x__xgafv: string, V1 error format.
145+
Allowed values
146+
1 - v1 error format
147+
2 - v2 error format
148+
149+
Returns:
150+
An object of the form:
151+
152+
{ # Describes the project/location configuration of Cloud Scheduler Resources.
153+
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. 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 Jobs in the region. Setting this as blank will turn off CMEK encryption.
154+
&quot;name&quot;: &quot;A String&quot;, # Identifier. 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`
155+
}</pre>
156+
</div>
157+
132158
<div class="method">
133159
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
134160
<pre>Lists information about the supported locations for this service.
135161

136162
Args:
137163
name: string, The resource that owns the locations collection, if applicable. (required)
138-
extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don&#x27;t use this unsupported field which is primarily intended for internal usage. (repeated)
164+
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)
139165
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).
140166
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
141167
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
@@ -179,4 +205,48 @@ <h3>Method Details</h3>
179205
</pre>
180206
</div>
181207

208+
<div class="method">
209+
<code class="details" id="updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
210+
<pre>Initializes or Updates the a scheduler config.
211+
212+
Args:
213+
name: string, Identifier. 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)
214+
body: object, The request body.
215+
The object takes the form of:
216+
217+
{ # Describes the project/location configuration of Cloud Scheduler Resources.
218+
&quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. 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 Jobs in the region. Setting this as blank will turn off CMEK encryption.
219+
&quot;name&quot;: &quot;A String&quot;, # Identifier. 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`
220+
}
221+
222+
updateMask: string, Optional. List of fields to be updated in this request.
223+
x__xgafv: string, V1 error format.
224+
Allowed values
225+
1 - v1 error format
226+
2 - v2 error format
227+
228+
Returns:
229+
An object of the form:
230+
231+
{ # This resource represents a long-running operation that is the result of a network API call.
232+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
233+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
234+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
235+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
236+
{
237+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
238+
},
239+
],
240+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
241+
},
242+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
243+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
244+
},
245+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
246+
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
247+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
248+
},
249+
}</pre>
250+
</div>
251+
182252
</body></html>

0 commit comments

Comments
 (0)