| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 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="runtimeconfig_v1beta1.html">Google Cloud RuntimeConfig 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> |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 80 | <p class="toc_element"> |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 81 | <code><a href="#testIamPermissions">testIamPermissions(resource, x__xgafv=None, permissions=None)</a></code></p> |
| Jon Wayne Parrott | 692617a | 2017-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 Parrott | 0a471d3 | 2016-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 |
| 87 | method to poll the operation result at intervals as recommended by the API |
| 88 | service. |
| 89 | |
| 90 | Args: |
| 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 | |
| 97 | Returns: |
| 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. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 106 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 107 | }, |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 108 | "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. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 109 | # programming environments, including REST APIs and RPC APIs. It is used by |
| 110 | # [gRPC](https://github.com/grpc). The error model is designed to be: |
| 111 | # |
| 112 | # - Simple to use and understand for most users |
| 113 | # - Flexible enough to meet unexpected needs |
| 114 | # |
| 115 | # # Overview |
| 116 | # |
| 117 | # The `Status` message contains three pieces of data: error code, error message, |
| 118 | # and error details. The error code should be an enum value of |
| 119 | # google.rpc.Code, but it may accept additional error codes if needed. The |
| 120 | # error message should be a developer-facing English message that helps |
| 121 | # developers *understand* and *resolve* the error. If a localized user-facing |
| 122 | # error message is needed, put the localized message in the error details or |
| 123 | # localize it in the client. The optional error details may contain arbitrary |
| 124 | # information about the error. There is a predefined set of error detail types |
| 125 | # in the package `google.rpc` which can be used for common error conditions. |
| 126 | # |
| 127 | # # Language mapping |
| 128 | # |
| 129 | # The `Status` message is the logical representation of the error model, but it |
| 130 | # is not necessarily the actual wire format. When the `Status` message is |
| 131 | # exposed in different client libraries and different wire protocols, it can be |
| 132 | # mapped differently. For example, it will likely be mapped to some exceptions |
| 133 | # in Java, but more likely mapped to some error codes in C. |
| 134 | # |
| 135 | # # Other uses |
| 136 | # |
| 137 | # The error model and the `Status` message can be used in a variety of |
| 138 | # environments, either with or without APIs, to provide a |
| 139 | # consistent developer experience across different environments. |
| 140 | # |
| 141 | # Example uses of this error model include: |
| 142 | # |
| 143 | # - Partial errors. If a service needs to return partial errors to the client, |
| 144 | # it may embed the `Status` in the normal response to indicate the partial |
| 145 | # errors. |
| 146 | # |
| 147 | # - Workflow errors. A typical workflow has multiple steps. Each step may |
| 148 | # have a `Status` message for error reporting purpose. |
| 149 | # |
| 150 | # - Batch operations. If a client uses batch request and batch response, the |
| 151 | # `Status` message should be used directly inside batch response, one for |
| 152 | # each error sub-response. |
| 153 | # |
| 154 | # - Asynchronous operations. If an API call embeds asynchronous operation |
| 155 | # results in its response, the status of those operations should be |
| 156 | # represented directly using the `Status` message. |
| 157 | # |
| 158 | # - Logging. If some API errors are stored in logs, the message `Status` could |
| 159 | # be used directly after any stripping needed for security/privacy reasons. |
| 160 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 161 | # user-facing error message should be localized and sent in the |
| 162 | # google.rpc.Status.details field, or localized by the client. |
| 163 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 164 | "details": [ # A list of messages that carry the error details. There will be a |
| 165 | # common set of message types for APIs to use. |
| 166 | { |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 167 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 168 | }, |
| 169 | ], |
| 170 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 171 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 172 | # If true, the operation is completed, and either `error` or `response` is |
| 173 | # available. |
| 174 | "response": { # The normal response of the operation in case of success. If the original |
| 175 | # method returns no data on success, such as `Delete`, the response is |
| 176 | # `google.protobuf.Empty`. If the original method is standard |
| 177 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 178 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 179 | # is the original method name. For example, if the original method name |
| 180 | # is `TakeSnapshot()`, the inferred response type is |
| 181 | # `TakeSnapshotResponse`. |
| 182 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 183 | }, |
| 184 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 185 | # originally returns it. If you use the default HTTP mapping, the |
| 186 | # `name` should have the format of `operations/some/unique/name`. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 187 | }</pre> |
| 188 | </div> |
| 189 | |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 190 | <div class="method"> |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 191 | <code class="details" id="testIamPermissions">testIamPermissions(resource, x__xgafv=None, permissions=None)</code> |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 192 | <pre>Returns permissions that a caller has on the specified resource. |
| 193 | If the resource does not exist, this will return an empty set of |
| 194 | permissions, not a NOT_FOUND error. |
| 195 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 196 | Note: This operation is designed to be used for building permission-aware |
| 197 | UIs and command-line tools, not for authorization checking. This operation |
| 198 | may "fail open" without warning. |
| 199 | |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 200 | Args: |
| 201 | resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 202 | See the operation documentation for the appropriate value for this field. (required) |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 203 | x__xgafv: string, V1 error format. |
| 204 | Allowed values |
| 205 | 1 - v1 error format |
| 206 | 2 - v2 error format |
| 207 | permissions: string, 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). (repeated) |
| 211 | |
| 212 | Returns: |
| 213 | An object of the form: |
| 214 | |
| 215 | { # Response message for `TestIamPermissions` method. |
| 216 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| 217 | # allowed. |
| 218 | "A String", |
| 219 | ], |
| 220 | }</pre> |
| 221 | </div> |
| 222 | |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 223 | </body></html> |