1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="runtimeconfig_v1beta1.projects.configs.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables()</a></code>
</p>
<p class="firstline">Returns the variables Resource.</p>
<p class="toc_element">
<code><a href="runtimeconfig_v1beta1.projects.configs.waiters.html">waiters()</a></code>
</p>
<p class="firstline">Returns the waiters Resource.</p>
<p class="toc_element">
<code><a href="#create">create(parent=None, body, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new RuntimeConfig resource. The configuration name must be</p>
<p class="toc_element">
<code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a RuntimeConfig resource.</p>
<p class="toc_element">
<code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a RuntimeConfig resource.</p>
<p class="toc_element">
<code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists all the RuntimeConfig resources within project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(name=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a RuntimeConfig resource. The configuration must exist beforehand.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent=None, body, requestId=None, x__xgafv=None)</code>
<pre>Creates a new RuntimeConfig resource. The configuration name must be
unique within project.
Args:
parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
for this request, in the format `projects/[PROJECT_ID]`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
# service. A RuntimeConfig resource consists of metadata and a hierarchy of
# variables.
"description": "A String", # An optional description of the RuntimeConfig object.
# The length of the description must be less than 256 bytes.
"name": "A String", # The resource name of a runtime config. The name must have the format:
#
# projects/[PROJECT_ID]/configs/[CONFIG_NAME]
#
# The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
# arbitrary name that matches RFC 1035 segment specification. The length of
# `[CONFIG_NAME]` must be less than 64 bytes.
#
# You pick the RuntimeConfig resource name, but the server will validate that
# the name adheres to this format. After you create the resource, you cannot
# change the resource's name.
}
requestId: string, An optional unique request_id. If server receives two Create requests with
the same request_id then second request will be ignored and the resource
stored in the backend will be returned. Empty request_id fields are
ignored.
It is responsibility of the client to ensure uniqueness of the request_id
strings.
The strings are limited to 64 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
# service. A RuntimeConfig resource consists of metadata and a hierarchy of
# variables.
"description": "A String", # An optional description of the RuntimeConfig object.
# The length of the description must be less than 256 bytes.
"name": "A String", # The resource name of a runtime config. The name must have the format:
#
# projects/[PROJECT_ID]/configs/[CONFIG_NAME]
#
# The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
# arbitrary name that matches RFC 1035 segment specification. The length of
# `[CONFIG_NAME]` must be less than 64 bytes.
#
# You pick the RuntimeConfig resource name, but the server will validate that
# the name adheres to this format. After you create the resource, you cannot
# change the resource's name.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
<pre>Deletes a RuntimeConfig resource.
Args:
name: string, The RuntimeConfig resource to delete, in the format:
`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name=None, x__xgafv=None)</code>
<pre>Gets information about a RuntimeConfig resource.
Args:
name: string, The name of the RuntimeConfig resource to retrieve, in the format:
`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
# service. A RuntimeConfig resource consists of metadata and a hierarchy of
# variables.
"description": "A String", # An optional description of the RuntimeConfig object.
# The length of the description must be less than 256 bytes.
"name": "A String", # The resource name of a runtime config. The name must have the format:
#
# projects/[PROJECT_ID]/configs/[CONFIG_NAME]
#
# The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
# arbitrary name that matches RFC 1035 segment specification. The length of
# `[CONFIG_NAME]` must be less than 64 bytes.
#
# You pick the RuntimeConfig resource name, but the server will validate that
# the name adheres to this format. After you create the resource, you cannot
# change the resource's name.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists all the RuntimeConfig resources within project.
Args:
parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
for this request, in the format `projects/[PROJECT_ID]`. (required)
pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
returned by a previous list request to get the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
pageSize: integer, Specifies the number of results to return per page. If there are fewer
elements than the specified number, returns all elements.
Returns:
An object of the form:
{ # `ListConfigs()` returns the following response. The order of returned
# objects is arbitrary; that is, it is not ordered in any particular way.
"nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
# If the number of results is larger than `pageSize`, use the `nextPageToken`
# as a value for the query parameter `pageToken` in the next list request.
# Subsequent list requests will have their own `nextPageToken` to continue
# paging through the results
"configs": [ # A list of the configurations in the project. The order of returned
# objects is arbitrary; that is, it is not ordered in any particular way.
{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
# service. A RuntimeConfig resource consists of metadata and a hierarchy of
# variables.
"description": "A String", # An optional description of the RuntimeConfig object.
# The length of the description must be less than 256 bytes.
"name": "A String", # The resource name of a runtime config. The name must have the format:
#
# projects/[PROJECT_ID]/configs/[CONFIG_NAME]
#
# The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
# arbitrary name that matches RFC 1035 segment specification. The length of
# `[CONFIG_NAME]` must be less than 64 bytes.
#
# You pick the RuntimeConfig resource name, but the server will validate that
# the name adheres to this format. After you create the resource, you cannot
# change the resource's name.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
<pre>Updates a RuntimeConfig resource. The configuration must exist beforehand.
Args:
name: string, The name of the RuntimeConfig resource to update, in the format:
`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
body: object, The request body. (required)
The object takes the form of:
{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
# service. A RuntimeConfig resource consists of metadata and a hierarchy of
# variables.
"description": "A String", # An optional description of the RuntimeConfig object.
# The length of the description must be less than 256 bytes.
"name": "A String", # The resource name of a runtime config. The name must have the format:
#
# projects/[PROJECT_ID]/configs/[CONFIG_NAME]
#
# The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
# arbitrary name that matches RFC 1035 segment specification. The length of
# `[CONFIG_NAME]` must be less than 64 bytes.
#
# You pick the RuntimeConfig resource name, but the server will validate that
# the name adheres to this format. After you create the resource, you cannot
# change the resource's name.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
# service. A RuntimeConfig resource consists of metadata and a hierarchy of
# variables.
"description": "A String", # An optional description of the RuntimeConfig object.
# The length of the description must be less than 256 bytes.
"name": "A String", # The resource name of a runtime config. The name must have the format:
#
# projects/[PROJECT_ID]/configs/[CONFIG_NAME]
#
# The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
# arbitrary name that matches RFC 1035 segment specification. The length of
# `[CONFIG_NAME]` must be less than 64 bytes.
#
# You pick the RuntimeConfig resource name, but the server will validate that
# the name adheres to this format. After you create the resource, you cannot
# change the resource's name.
}</pre>
</div>
</body></html>
|