• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
75<h1><a href="runtimeconfig_v1beta1.html">Google 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>
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>
80<p class="toc_element">
81  <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
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.
102    "metadata": { # Service-specific metadata associated with the operation.  It typically
103        # contains progress information and common metadata such as create time.
104        # Some services might not provide such metadata.  Any method that returns a
105        # long-running operation should document the metadata type, if any.
106      "a_key": "", # Properties of the object. Contains field @type with type URL.
107    },
108    "done": True or False, # If the value is `false`, it means the operation is still in progress.
109        # If true, the operation is completed, and either `error` or `response` is
110        # available.
111    "response": { # The normal response of the operation in case of success.  If the original
112        # method returns no data on success, such as `Delete`, the response is
113        # `google.protobuf.Empty`.  If the original method is standard
114        # `Get`/`Create`/`Update`, the response should be the resource.  For other
115        # methods, the response should have the type `XxxResponse`, where `Xxx`
116        # is the original method name.  For example, if the original method name
117        # is `TakeSnapshot()`, the inferred response type is
118        # `TakeSnapshotResponse`.
119      "a_key": "", # Properties of the object. Contains field @type with type URL.
120    },
121    "name": "A String", # The server-assigned name, which is only unique within the same service that
122        # originally returns it. If you use the default HTTP mapping, the
123        # `name` should have the format of `operations/some/unique/name`.
124    "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
125        # programming environments, including REST APIs and RPC APIs. It is used by
126        # [gRPC](https://github.com/grpc). The error model is designed to be:
127        #
128        # - Simple to use and understand for most users
129        # - Flexible enough to meet unexpected needs
130        #
131        # # Overview
132        #
133        # The `Status` message contains three pieces of data: error code, error message,
134        # and error details. The error code should be an enum value of
135        # google.rpc.Code, but it may accept additional error codes if needed.  The
136        # error message should be a developer-facing English message that helps
137        # developers *understand* and *resolve* the error. If a localized user-facing
138        # error message is needed, put the localized message in the error details or
139        # localize it in the client. The optional error details may contain arbitrary
140        # information about the error. There is a predefined set of error detail types
141        # in the package `google.rpc` that can be used for common error conditions.
142        #
143        # # Language mapping
144        #
145        # The `Status` message is the logical representation of the error model, but it
146        # is not necessarily the actual wire format. When the `Status` message is
147        # exposed in different client libraries and different wire protocols, it can be
148        # mapped differently. For example, it will likely be mapped to some exceptions
149        # in Java, but more likely mapped to some error codes in C.
150        #
151        # # Other uses
152        #
153        # The error model and the `Status` message can be used in a variety of
154        # environments, either with or without APIs, to provide a
155        # consistent developer experience across different environments.
156        #
157        # Example uses of this error model include:
158        #
159        # - Partial errors. If a service needs to return partial errors to the client,
160        #     it may embed the `Status` in the normal response to indicate the partial
161        #     errors.
162        #
163        # - Workflow errors. A typical workflow has multiple steps. Each step may
164        #     have a `Status` message for error reporting.
165        #
166        # - Batch operations. If a client uses batch request and batch response, the
167        #     `Status` message should be used directly inside batch response, one for
168        #     each error sub-response.
169        #
170        # - Asynchronous operations. If an API call embeds asynchronous operation
171        #     results in its response, the status of those operations should be
172        #     represented directly using the `Status` message.
173        #
174        # - Logging. If some API errors are stored in logs, the message `Status` could
175        #     be used directly after any stripping needed for security/privacy reasons.
176      "message": "A String", # A developer-facing error message, which should be in English. Any
177          # user-facing error message should be localized and sent in the
178          # google.rpc.Status.details field, or localized by the client.
179      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
180      "details": [ # A list of messages that carry the error details.  There will be a
181          # common set of message types for APIs to use.
182        {
183          "a_key": "", # Properties of the object. Contains field @type with type URL.
184        },
185      ],
186    },
187  }</pre>
188</div>
189
190<div class="method">
191    <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
192  <pre>Returns permissions that a caller has on the specified resource.
193If the resource does not exist, this will return an empty set of
194permissions, not a NOT_FOUND error.
195
196Note: This operation is designed to be used for building permission-aware
197UIs and command-line tools, not for authorization checking. This operation
198may "fail open" without warning.
199
200Args:
201  resource: string, REQUIRED: The resource for which the policy detail is being requested.
202See the operation documentation for the appropriate value for this field. (required)
203  body: object, The request body. (required)
204    The object takes the form of:
205
206{ # Request message for `TestIamPermissions` method.
207    "permissions": [ # The set of permissions to check for the `resource`. Permissions with
208        # wildcards (such as '*' or 'storage.*') are not allowed. For more
209        # information see
210        # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
211      "A String",
212    ],
213  }
214
215  x__xgafv: string, V1 error format.
216    Allowed values
217      1 - v1 error format
218      2 - v2 error format
219
220Returns:
221  An object of the form:
222
223    { # Response message for `TestIamPermissions` method.
224    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
225        # allowed.
226      "A String",
227    ],
228  }</pre>
229</div>
230
231</body></html>