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 | |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 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></h1> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="runtimeconfig_v1beta1.projects.configs.operations.html">operations()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the operations Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the variables Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="runtimeconfig_v1beta1.projects.configs.waiters.html">waiters()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the waiters Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 93 | <code><a href="#create">create(parent, body, requestId=None, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 94 | <p class="firstline">Creates a new RuntimeConfig resource. The configuration name must be</p> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 96 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 97 | <p class="firstline">Deletes a RuntimeConfig resource.</p> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 98 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 99 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 100 | <p class="firstline">Gets information about a RuntimeConfig resource.</p> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 101 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 102 | <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 103 | <p class="firstline">Gets the access control policy for a resource.</p> |
| 104 | <p class="toc_element"> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 105 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 106 | <p class="firstline">Lists all the RuntimeConfig resources within project.</p> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 107 | <p class="toc_element"> |
| 108 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 109 | <p class="firstline">Retrieves the next page of results.</p> |
| 110 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 111 | <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 112 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> |
| 113 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 114 | <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 115 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 116 | <p class="toc_element"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 117 | <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 118 | <p class="firstline">Updates a RuntimeConfig resource. The configuration must exist beforehand.</p> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 119 | <h3>Method Details</h3> |
| 120 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 121 | <code class="details" id="create">create(parent, body, requestId=None, x__xgafv=None)</code> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 122 | <pre>Creates a new RuntimeConfig resource. The configuration name must be |
| 123 | unique within project. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 124 | |
| 125 | Args: |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 126 | parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) |
| 127 | for this request, in the format `projects/[PROJECT_ID]`. (required) |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 128 | body: object, The request body. (required) |
| 129 | The object takes the form of: |
| 130 | |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 131 | { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 132 | # service. A RuntimeConfig resource consists of metadata and a hierarchy of |
| 133 | # variables. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 134 | "description": "A String", # An optional description of the RuntimeConfig object. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 135 | "name": "A String", # The resource name of a runtime config. The name must have the format: |
| 136 | # |
| 137 | # projects/[PROJECT_ID]/configs/[CONFIG_NAME] |
| 138 | # |
| 139 | # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an |
| 140 | # arbitrary name that matches RFC 1035 segment specification. The length of |
| 141 | # `[CONFIG_NAME]` must be less than 64 bytes. |
| 142 | # |
| 143 | # You pick the RuntimeConfig resource name, but the server will validate that |
| 144 | # the name adheres to this format. After you create the resource, you cannot |
| 145 | # change the resource's name. |
| 146 | } |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 147 | |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 148 | requestId: string, An optional but recommended unique `request_id`. If the server |
| 149 | receives two `create()` requests with the same |
| 150 | `request_id`, then the second request will be ignored and the |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 151 | first resource created and stored in the backend is returned. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 152 | Empty `request_id` fields are ignored. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 153 | |
| 154 | It is responsibility of the client to ensure uniqueness of the |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 155 | `request_id` strings. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 156 | |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 157 | `request_id` strings are limited to 64 characters. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 158 | x__xgafv: string, V1 error format. |
| 159 | Allowed values |
| 160 | 1 - v1 error format |
| 161 | 2 - v2 error format |
| 162 | |
| 163 | Returns: |
| 164 | An object of the form: |
| 165 | |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 166 | { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 167 | # service. A RuntimeConfig resource consists of metadata and a hierarchy of |
| 168 | # variables. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 169 | "description": "A String", # An optional description of the RuntimeConfig object. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 170 | "name": "A String", # The resource name of a runtime config. The name must have the format: |
| 171 | # |
| 172 | # projects/[PROJECT_ID]/configs/[CONFIG_NAME] |
| 173 | # |
| 174 | # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an |
| 175 | # arbitrary name that matches RFC 1035 segment specification. The length of |
| 176 | # `[CONFIG_NAME]` must be less than 64 bytes. |
| 177 | # |
| 178 | # You pick the RuntimeConfig resource name, but the server will validate that |
| 179 | # the name adheres to this format. After you create the resource, you cannot |
| 180 | # change the resource's name. |
| 181 | }</pre> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 182 | </div> |
| 183 | |
| 184 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 185 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 186 | <pre>Deletes a RuntimeConfig resource. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 187 | |
| 188 | Args: |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 189 | name: string, The RuntimeConfig resource to delete, in the format: |
| 190 | |
| 191 | `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required) |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 192 | x__xgafv: string, V1 error format. |
| 193 | Allowed values |
| 194 | 1 - v1 error format |
| 195 | 2 - v2 error format |
| 196 | |
| 197 | Returns: |
| 198 | An object of the form: |
| 199 | |
| 200 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 201 | # empty messages in your APIs. A typical example is to use it as the request |
| 202 | # or the response type of an API method. For instance: |
| 203 | # |
| 204 | # service Foo { |
| 205 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 206 | # } |
| 207 | # |
| 208 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 209 | }</pre> |
| 210 | </div> |
| 211 | |
| 212 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 213 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 214 | <pre>Gets information about a RuntimeConfig resource. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 215 | |
| 216 | Args: |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 217 | name: string, The name of the RuntimeConfig resource to retrieve, in the format: |
| 218 | |
| 219 | `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required) |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 220 | x__xgafv: string, V1 error format. |
| 221 | Allowed values |
| 222 | 1 - v1 error format |
| 223 | 2 - v2 error format |
| 224 | |
| 225 | Returns: |
| 226 | An object of the form: |
| 227 | |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 228 | { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 229 | # service. A RuntimeConfig resource consists of metadata and a hierarchy of |
| 230 | # variables. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 231 | "description": "A String", # An optional description of the RuntimeConfig object. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 232 | "name": "A String", # The resource name of a runtime config. The name must have the format: |
| 233 | # |
| 234 | # projects/[PROJECT_ID]/configs/[CONFIG_NAME] |
| 235 | # |
| 236 | # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an |
| 237 | # arbitrary name that matches RFC 1035 segment specification. The length of |
| 238 | # `[CONFIG_NAME]` must be less than 64 bytes. |
| 239 | # |
| 240 | # You pick the RuntimeConfig resource name, but the server will validate that |
| 241 | # the name adheres to this format. After you create the resource, you cannot |
| 242 | # change the resource's name. |
| 243 | }</pre> |
| 244 | </div> |
| 245 | |
| 246 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 247 | <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 248 | <pre>Gets the access control policy for a resource. |
| 249 | Returns an empty policy if the resource exists and does not have a policy |
| 250 | set. |
| 251 | |
| 252 | Args: |
| 253 | resource: string, REQUIRED: The resource for which the policy is being requested. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 254 | 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] | 255 | x__xgafv: string, V1 error format. |
| 256 | Allowed values |
| 257 | 1 - v1 error format |
| 258 | 2 - v2 error format |
| 259 | |
| 260 | Returns: |
| 261 | An object of the form: |
| 262 | |
| 263 | { # Defines an Identity and Access Management (IAM) policy. It is used to |
| 264 | # specify access control policies for Cloud Platform resources. |
| 265 | # |
| 266 | # |
| 267 | # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of |
| 268 | # `members` to a `role`, where the members can be user accounts, Google groups, |
| 269 | # Google domains, and service accounts. A `role` is a named list of permissions |
| 270 | # defined by IAM. |
| 271 | # |
| 272 | # **Example** |
| 273 | # |
| 274 | # { |
| 275 | # "bindings": [ |
| 276 | # { |
| 277 | # "role": "roles/owner", |
| 278 | # "members": [ |
| 279 | # "user:mike@example.com", |
| 280 | # "group:admins@example.com", |
| 281 | # "domain:google.com", |
| 282 | # "serviceAccount:my-other-app@appspot.gserviceaccount.com", |
| 283 | # ] |
| 284 | # }, |
| 285 | # { |
| 286 | # "role": "roles/viewer", |
| 287 | # "members": ["user:sean@example.com"] |
| 288 | # } |
| 289 | # ] |
| 290 | # } |
| 291 | # |
| 292 | # For a description of IAM and its features, see the |
| 293 | # [IAM developer's guide](https://cloud.google.com/iam). |
| 294 | "bindings": [ # Associates a list of `members` to a `role`. |
| 295 | # Multiple `bindings` must not be specified for the same `role`. |
| 296 | # `bindings` with no members will result in an error. |
| 297 | { # Associates `members` with a `role`. |
| 298 | "role": "A String", # Role that is assigned to `members`. |
| 299 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 300 | # Required |
| 301 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 302 | # `members` can have the following values: |
| 303 | # |
| 304 | # * `allUsers`: A special identifier that represents anyone who is |
| 305 | # on the internet; with or without a Google account. |
| 306 | # |
| 307 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 308 | # who is authenticated with a Google account or a service account. |
| 309 | # |
| 310 | # * `user:{emailid}`: An email address that represents a specific Google |
| 311 | # account. For example, `alice@gmail.com` or `joe@example.com`. |
| 312 | # |
| 313 | # |
| 314 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 315 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 316 | # |
| 317 | # * `group:{emailid}`: An email address that represents a Google group. |
| 318 | # For example, `admins@example.com`. |
| 319 | # |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 320 | # |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 321 | # * `domain:{domain}`: A Google Apps domain name that represents all the |
| 322 | # users of that domain. For example, `google.com` or `example.com`. |
| 323 | # |
| 324 | "A String", |
| 325 | ], |
| 326 | }, |
| 327 | ], |
| 328 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 329 | # prevent simultaneous updates of a policy from overwriting each other. |
| 330 | # It is strongly suggested that systems make use of the `etag` in the |
| 331 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 332 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 333 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 334 | # ensure that their change will be applied to the same version of the policy. |
| 335 | # |
| 336 | # If no `etag` is provided in the call to `setIamPolicy`, then the existing |
| 337 | # policy is overwritten blindly. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 338 | "version": 42, # Version of the `Policy`. The default version is 0. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 339 | }</pre> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 340 | </div> |
| 341 | |
| 342 | <div class="method"> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 343 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 344 | <pre>Lists all the RuntimeConfig resources within project. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 345 | |
| 346 | Args: |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 347 | parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) |
| 348 | for this request, in the format `projects/[PROJECT_ID]`. (required) |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 349 | pageSize: integer, Specifies the number of results to return per page. If there are fewer |
| 350 | elements than the specified number, returns all elements. |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 351 | pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken` |
| 352 | returned by a previous list request to get the next page of results. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 353 | x__xgafv: string, V1 error format. |
| 354 | Allowed values |
| 355 | 1 - v1 error format |
| 356 | 2 - v2 error format |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 357 | |
| 358 | Returns: |
| 359 | An object of the form: |
| 360 | |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 361 | { # `ListConfigs()` returns the following response. The order of returned |
| 362 | # objects is arbitrary; that is, it is not ordered in any particular way. |
| 363 | "nextPageToken": "A String", # This token allows you to get the next page of results for list requests. |
| 364 | # If the number of results is larger than `pageSize`, use the `nextPageToken` |
| 365 | # as a value for the query parameter `pageToken` in the next list request. |
| 366 | # Subsequent list requests will have their own `nextPageToken` to continue |
| 367 | # paging through the results |
| 368 | "configs": [ # A list of the configurations in the project. The order of returned |
| 369 | # objects is arbitrary; that is, it is not ordered in any particular way. |
| 370 | { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 371 | # service. A RuntimeConfig resource consists of metadata and a hierarchy of |
| 372 | # variables. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 373 | "description": "A String", # An optional description of the RuntimeConfig object. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 374 | "name": "A String", # The resource name of a runtime config. The name must have the format: |
| 375 | # |
| 376 | # projects/[PROJECT_ID]/configs/[CONFIG_NAME] |
| 377 | # |
| 378 | # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an |
| 379 | # arbitrary name that matches RFC 1035 segment specification. The length of |
| 380 | # `[CONFIG_NAME]` must be less than 64 bytes. |
| 381 | # |
| 382 | # You pick the RuntimeConfig resource name, but the server will validate that |
| 383 | # the name adheres to this format. After you create the resource, you cannot |
| 384 | # change the resource's name. |
| 385 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 386 | ], |
| 387 | }</pre> |
| 388 | </div> |
| 389 | |
| 390 | <div class="method"> |
| 391 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 392 | <pre>Retrieves the next page of results. |
| 393 | |
| 394 | Args: |
| 395 | previous_request: The request for the previous page. (required) |
| 396 | previous_response: The response from the request for the previous page. (required) |
| 397 | |
| 398 | Returns: |
| 399 | A request object that you can call 'execute()' on to request the next |
| 400 | page. Returns None if there are no more items in the collection. |
| 401 | </pre> |
| 402 | </div> |
| 403 | |
| 404 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 405 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 406 | <pre>Sets the access control policy on the specified resource. Replaces any |
| 407 | existing policy. |
| 408 | |
| 409 | Args: |
| 410 | resource: string, REQUIRED: The resource for which the policy is being specified. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 411 | 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] | 412 | body: object, The request body. (required) |
| 413 | The object takes the form of: |
| 414 | |
| 415 | { # Request message for `SetIamPolicy` method. |
| 416 | "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| 417 | # the policy is limited to a few 10s of KB. An empty policy is a |
| 418 | # valid policy but certain Cloud Platform services (such as Projects) |
| 419 | # might reject them. |
| 420 | # specify access control policies for Cloud Platform resources. |
| 421 | # |
| 422 | # |
| 423 | # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of |
| 424 | # `members` to a `role`, where the members can be user accounts, Google groups, |
| 425 | # Google domains, and service accounts. A `role` is a named list of permissions |
| 426 | # defined by IAM. |
| 427 | # |
| 428 | # **Example** |
| 429 | # |
| 430 | # { |
| 431 | # "bindings": [ |
| 432 | # { |
| 433 | # "role": "roles/owner", |
| 434 | # "members": [ |
| 435 | # "user:mike@example.com", |
| 436 | # "group:admins@example.com", |
| 437 | # "domain:google.com", |
| 438 | # "serviceAccount:my-other-app@appspot.gserviceaccount.com", |
| 439 | # ] |
| 440 | # }, |
| 441 | # { |
| 442 | # "role": "roles/viewer", |
| 443 | # "members": ["user:sean@example.com"] |
| 444 | # } |
| 445 | # ] |
| 446 | # } |
| 447 | # |
| 448 | # For a description of IAM and its features, see the |
| 449 | # [IAM developer's guide](https://cloud.google.com/iam). |
| 450 | "bindings": [ # Associates a list of `members` to a `role`. |
| 451 | # Multiple `bindings` must not be specified for the same `role`. |
| 452 | # `bindings` with no members will result in an error. |
| 453 | { # Associates `members` with a `role`. |
| 454 | "role": "A String", # Role that is assigned to `members`. |
| 455 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 456 | # Required |
| 457 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 458 | # `members` can have the following values: |
| 459 | # |
| 460 | # * `allUsers`: A special identifier that represents anyone who is |
| 461 | # on the internet; with or without a Google account. |
| 462 | # |
| 463 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 464 | # who is authenticated with a Google account or a service account. |
| 465 | # |
| 466 | # * `user:{emailid}`: An email address that represents a specific Google |
| 467 | # account. For example, `alice@gmail.com` or `joe@example.com`. |
| 468 | # |
| 469 | # |
| 470 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 471 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 472 | # |
| 473 | # * `group:{emailid}`: An email address that represents a Google group. |
| 474 | # For example, `admins@example.com`. |
| 475 | # |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 476 | # |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 477 | # * `domain:{domain}`: A Google Apps domain name that represents all the |
| 478 | # users of that domain. For example, `google.com` or `example.com`. |
| 479 | # |
| 480 | "A String", |
| 481 | ], |
| 482 | }, |
| 483 | ], |
| 484 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 485 | # prevent simultaneous updates of a policy from overwriting each other. |
| 486 | # It is strongly suggested that systems make use of the `etag` in the |
| 487 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 488 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 489 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 490 | # ensure that their change will be applied to the same version of the policy. |
| 491 | # |
| 492 | # If no `etag` is provided in the call to `setIamPolicy`, then the existing |
| 493 | # policy is overwritten blindly. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 494 | "version": 42, # Version of the `Policy`. The default version is 0. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 495 | }, |
| 496 | } |
| 497 | |
| 498 | x__xgafv: string, V1 error format. |
| 499 | Allowed values |
| 500 | 1 - v1 error format |
| 501 | 2 - v2 error format |
| 502 | |
| 503 | Returns: |
| 504 | An object of the form: |
| 505 | |
| 506 | { # Defines an Identity and Access Management (IAM) policy. It is used to |
| 507 | # specify access control policies for Cloud Platform resources. |
| 508 | # |
| 509 | # |
| 510 | # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of |
| 511 | # `members` to a `role`, where the members can be user accounts, Google groups, |
| 512 | # Google domains, and service accounts. A `role` is a named list of permissions |
| 513 | # defined by IAM. |
| 514 | # |
| 515 | # **Example** |
| 516 | # |
| 517 | # { |
| 518 | # "bindings": [ |
| 519 | # { |
| 520 | # "role": "roles/owner", |
| 521 | # "members": [ |
| 522 | # "user:mike@example.com", |
| 523 | # "group:admins@example.com", |
| 524 | # "domain:google.com", |
| 525 | # "serviceAccount:my-other-app@appspot.gserviceaccount.com", |
| 526 | # ] |
| 527 | # }, |
| 528 | # { |
| 529 | # "role": "roles/viewer", |
| 530 | # "members": ["user:sean@example.com"] |
| 531 | # } |
| 532 | # ] |
| 533 | # } |
| 534 | # |
| 535 | # For a description of IAM and its features, see the |
| 536 | # [IAM developer's guide](https://cloud.google.com/iam). |
| 537 | "bindings": [ # Associates a list of `members` to a `role`. |
| 538 | # Multiple `bindings` must not be specified for the same `role`. |
| 539 | # `bindings` with no members will result in an error. |
| 540 | { # Associates `members` with a `role`. |
| 541 | "role": "A String", # Role that is assigned to `members`. |
| 542 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 543 | # Required |
| 544 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 545 | # `members` can have the following values: |
| 546 | # |
| 547 | # * `allUsers`: A special identifier that represents anyone who is |
| 548 | # on the internet; with or without a Google account. |
| 549 | # |
| 550 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 551 | # who is authenticated with a Google account or a service account. |
| 552 | # |
| 553 | # * `user:{emailid}`: An email address that represents a specific Google |
| 554 | # account. For example, `alice@gmail.com` or `joe@example.com`. |
| 555 | # |
| 556 | # |
| 557 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 558 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 559 | # |
| 560 | # * `group:{emailid}`: An email address that represents a Google group. |
| 561 | # For example, `admins@example.com`. |
| 562 | # |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 563 | # |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 564 | # * `domain:{domain}`: A Google Apps domain name that represents all the |
| 565 | # users of that domain. For example, `google.com` or `example.com`. |
| 566 | # |
| 567 | "A String", |
| 568 | ], |
| 569 | }, |
| 570 | ], |
| 571 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 572 | # prevent simultaneous updates of a policy from overwriting each other. |
| 573 | # It is strongly suggested that systems make use of the `etag` in the |
| 574 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 575 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 576 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 577 | # ensure that their change will be applied to the same version of the policy. |
| 578 | # |
| 579 | # If no `etag` is provided in the call to `setIamPolicy`, then the existing |
| 580 | # policy is overwritten blindly. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 581 | "version": 42, # Version of the `Policy`. The default version is 0. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 582 | }</pre> |
| 583 | </div> |
| 584 | |
| 585 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 586 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 587 | <pre>Returns permissions that a caller has on the specified resource. |
| 588 | If the resource does not exist, this will return an empty set of |
| 589 | permissions, not a NOT_FOUND error. |
| 590 | |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 591 | Note: This operation is designed to be used for building permission-aware |
| 592 | UIs and command-line tools, not for authorization checking. This operation |
| 593 | may "fail open" without warning. |
| 594 | |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 595 | Args: |
| 596 | 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] | 597 | 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] | 598 | body: object, The request body. (required) |
| 599 | The object takes the form of: |
| 600 | |
| 601 | { # Request message for `TestIamPermissions` method. |
| 602 | "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| 603 | # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| 604 | # information see |
| 605 | # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| 606 | "A String", |
| 607 | ], |
| 608 | } |
| 609 | |
| 610 | x__xgafv: string, V1 error format. |
| 611 | Allowed values |
| 612 | 1 - v1 error format |
| 613 | 2 - v2 error format |
| 614 | |
| 615 | Returns: |
| 616 | An object of the form: |
| 617 | |
| 618 | { # Response message for `TestIamPermissions` method. |
| 619 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| 620 | # allowed. |
| 621 | "A String", |
| 622 | ], |
| 623 | }</pre> |
| 624 | </div> |
| 625 | |
| 626 | <div class="method"> |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 627 | <code class="details" id="update">update(name, body, x__xgafv=None)</code> |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 628 | <pre>Updates a RuntimeConfig resource. The configuration must exist beforehand. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 629 | |
| 630 | Args: |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 631 | name: string, The name of the RuntimeConfig resource to update, in the format: |
| 632 | |
| 633 | `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required) |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 634 | body: object, The request body. (required) |
| 635 | The object takes the form of: |
| 636 | |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 637 | { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 638 | # service. A RuntimeConfig resource consists of metadata and a hierarchy of |
| 639 | # variables. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 640 | "description": "A String", # An optional description of the RuntimeConfig object. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 641 | "name": "A String", # The resource name of a runtime config. The name must have the format: |
| 642 | # |
| 643 | # projects/[PROJECT_ID]/configs/[CONFIG_NAME] |
| 644 | # |
| 645 | # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an |
| 646 | # arbitrary name that matches RFC 1035 segment specification. The length of |
| 647 | # `[CONFIG_NAME]` must be less than 64 bytes. |
| 648 | # |
| 649 | # You pick the RuntimeConfig resource name, but the server will validate that |
| 650 | # the name adheres to this format. After you create the resource, you cannot |
| 651 | # change the resource's name. |
| 652 | } |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 653 | |
| 654 | x__xgafv: string, V1 error format. |
| 655 | Allowed values |
| 656 | 1 - v1 error format |
| 657 | 2 - v2 error format |
| 658 | |
| 659 | Returns: |
| 660 | An object of the form: |
| 661 | |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 662 | { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 663 | # service. A RuntimeConfig resource consists of metadata and a hierarchy of |
| 664 | # variables. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 665 | "description": "A String", # An optional description of the RuntimeConfig object. |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 666 | "name": "A String", # The resource name of a runtime config. The name must have the format: |
| 667 | # |
| 668 | # projects/[PROJECT_ID]/configs/[CONFIG_NAME] |
| 669 | # |
| 670 | # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an |
| 671 | # arbitrary name that matches RFC 1035 segment specification. The length of |
| 672 | # `[CONFIG_NAME]` must be less than 64 bytes. |
| 673 | # |
| 674 | # You pick the RuntimeConfig resource name, but the server will validate that |
| 675 | # the name adheres to this format. After you create the resource, you cannot |
| 676 | # change the resource's name. |
| 677 | }</pre> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 678 | </div> |
| 679 | |
| 680 | </body></html> |