Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.operations.html
blob: 9602f8e87e11ed6dc925b4df9f014d925f532260 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="runtimeconfig_v1beta1.html">Cloud Runtime Configuration API</a> . <a href="runtimeconfig_v1beta1.projects.html">projects</a> . <a href="runtimeconfig_v1beta1.projects.configs.html">configs</a> . <a href="runtimeconfig_v1beta1.projects.configs.operations.html">operations</a></h1>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]82<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(name, x__xgafv=None)</code>
86 <pre>Gets the latest state of a long-running operation. Clients can use this
87method to poll the operation result at intervals as recommended by the API
88service.
89
90Args:
91 name: string, The name of the operation resource. (required)
92 x__xgafv: string, V1 error format.
93 Allowed values
94 1 - v1 error format
95 2 - v2 error format
96
97Returns:
98 An object of the form:
99
100 { # This resource represents a long-running operation that is the result of a
101 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]102 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
103 # If `true`, the operation is completed, and either `error` or `response` is
104 # available.
105 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
106 # originally returns it. If you use the default HTTP mapping, the
107 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]108 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
109 # contains progress information and common metadata such as create time.
110 # Some services might not provide such metadata. Any method that returns a
111 # long-running operation should document the metadata type, if any.
112 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
113 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]114 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
115 # method returns no data on success, such as `Delete`, the response is
116 # `google.protobuf.Empty`. If the original method is standard
117 # `Get`/`Create`/`Update`, the response should be the resource. For other
118 # methods, the response should have the type `XxxResponse`, where `Xxx`
119 # is the original method name. For example, if the original method name
120 # is `TakeSnapshot()`, the inferred response type is
121 # `TakeSnapshotResponse`.
122 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
123 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]124 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 # different programming environments, including REST APIs and RPC APIs. It is
126 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
127 # three pieces of data: error code, error message, and error details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]128 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 # You can find out more about this error model and how to work with it in the
130 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
132 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
133 # user-facing error message should be localized and sent in the
134 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 # message types for APIs to use.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]137 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]139 },
140 ],
141 },
142 }</pre>
143</div>
144
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]145<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]146 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]147 <pre>Returns permissions that a caller has on the specified resource.
148If the resource does not exist, this will return an empty set of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]149permissions, not a `NOT_FOUND` error.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]150
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]151Note: This operation is designed to be used for building permission-aware
152UIs and command-line tools, not for authorization checking. This operation
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153may &quot;fail open&quot; without warning.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]154
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]155Args:
156 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]157See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]158 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]159 The object takes the form of:
160
161{ # Request message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with
163 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]164 # information see
165 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 &quot;A String&quot;,
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]167 ],
168 }
169
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]170 x__xgafv: string, V1 error format.
171 Allowed values
172 1 - v1 error format
173 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]174
175Returns:
176 An object of the form:
177
178 { # Response message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]180 # allowed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]182 ],
183 }</pre>
184</div>
185
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]186</body></html>