| <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="parametermanager_v1.html">Parameter Manager API</a> . <a href="parametermanager_v1.projects.html">projects</a> . <a href="parametermanager_v1.projects.locations.html">locations</a> . <a href="parametermanager_v1.projects.locations.parameters.html">parameters</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="parametermanager_v1.projects.locations.parameters.versions.html">versions()</a></code> |
| </p> |
| <p class="firstline">Returns the versions Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, parameterId=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new Parameter in a given project and location.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a single Parameter.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single Parameter.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists Parameters in a given project and location.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a single Parameter.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, parameterId=None, requestId=None, x__xgafv=None)</code> |
| <pre>Creates a new Parameter in a given project and location. |
| |
| Args: |
| parent: string, Required. Value for parent in the format `projects/*/locations/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Message describing Parameter resource |
| "createTime": "A String", # Output only. [Output only] Create time stamp |
| "format": "A String", # Optional. Specifies the format of a Parameter. |
| "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. |
| "labels": { # Optional. Labels as key value pairs |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. |
| "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. |
| "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` |
| "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` |
| }, |
| "updateTime": "A String", # Output only. [Output only] Update time stamp |
| } |
| |
| parameterId: string, Required. Id of the Parameter resource |
| requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message describing Parameter resource |
| "createTime": "A String", # Output only. [Output only] Create time stamp |
| "format": "A String", # Optional. Specifies the format of a Parameter. |
| "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. |
| "labels": { # Optional. Labels as key value pairs |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. |
| "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. |
| "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` |
| "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` |
| }, |
| "updateTime": "A String", # Output only. [Output only] Update time stamp |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code> |
| <pre>Deletes a single Parameter. |
| |
| Args: |
| name: string, Required. Name of the resource in the format `projects/*/locations/*/parameters/*`. (required) |
| requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single Parameter. |
| |
| Args: |
| name: string, Required. Name of the resource in the format `projects/*/locations/*/parameters/*`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message describing Parameter resource |
| "createTime": "A String", # Output only. [Output only] Create time stamp |
| "format": "A String", # Optional. Specifies the format of a Parameter. |
| "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. |
| "labels": { # Optional. Labels as key value pairs |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. |
| "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. |
| "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` |
| "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` |
| }, |
| "updateTime": "A String", # Output only. [Output only] Update time stamp |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists Parameters in a given project and location. |
| |
| Args: |
| parent: string, Required. Parent value for ListParametersRequest in the format `projects/*/locations/*`. (required) |
| filter: string, Optional. Filtering results |
| orderBy: string, Optional. Hint for how to order the results |
| pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| pageToken: string, Optional. A token identifying a page of results the server should return. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message for response to listing Parameters |
| "nextPageToken": "A String", # A token identifying a page of results the server should return. |
| "parameters": [ # The list of Parameters |
| { # Message describing Parameter resource |
| "createTime": "A String", # Output only. [Output only] Create time stamp |
| "format": "A String", # Optional. Specifies the format of a Parameter. |
| "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. |
| "labels": { # Optional. Labels as key value pairs |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. |
| "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. |
| "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` |
| "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` |
| }, |
| "updateTime": "A String", # Output only. [Output only] Update time stamp |
| }, |
| ], |
| "unreachable": [ # Unordered list. Locations that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</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="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates a single Parameter. |
| |
| Args: |
| name: string, Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Message describing Parameter resource |
| "createTime": "A String", # Output only. [Output only] Create time stamp |
| "format": "A String", # Optional. Specifies the format of a Parameter. |
| "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. |
| "labels": { # Optional. Labels as key value pairs |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. |
| "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. |
| "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` |
| "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` |
| }, |
| "updateTime": "A String", # Output only. [Output only] Update time stamp |
| } |
| |
| requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Parameter resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message describing Parameter resource |
| "createTime": "A String", # Output only. [Output only] Create time stamp |
| "format": "A String", # Optional. Specifies the format of a Parameter. |
| "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. |
| "labels": { # Optional. Labels as key value pairs |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. |
| "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. |
| "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` |
| "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` |
| }, |
| "updateTime": "A String", # Output only. [Output only] Update time stamp |
| }</pre> |
| </div> |
| |
| </body></html> |
