| <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> |