| <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="alloydb_v1alpha.html">AlloyDB API</a> . <a href="alloydb_v1alpha.projects.html">projects</a> . <a href="alloydb_v1alpha.projects.locations.html">locations</a> . <a href="alloydb_v1alpha.projects.locations.clusters.html">clusters</a> . <a href="alloydb_v1alpha.projects.locations.clusters.users.html">users</a></h1> |
| <h2>Instance Methods</h2> |
| <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, requestId=None, userId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new User in a given project, location, and cluster.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a single User.</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 User.</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 Users 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, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the parameters of a single User.</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, requestId=None, userId=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Creates a new User in a given project, location, and cluster. |
| |
| Args: |
| parent: string, Required. Value for parent. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Message describing User object. |
| "databaseRoles": [ # Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
| "A String", |
| ], |
| "keepExtraRoles": True or False, # Input only. If the user already exists and it has additional roles, keep them granted. |
| "name": "A String", # Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
| "password": "A String", # Input only. Password for the user. |
| "userType": "A String", # Optional. Type of this user. |
| } |
| |
| 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 ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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). |
| userId: string, Required. ID of the requesting object. |
| validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message describing User object. |
| "databaseRoles": [ # Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
| "A String", |
| ], |
| "keepExtraRoles": True or False, # Input only. If the user already exists and it has additional roles, keep them granted. |
| "name": "A String", # Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
| "password": "A String", # Input only. Password for the user. |
| "userType": "A String", # Optional. Type of this user. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, requestId=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Deletes a single User. |
| |
| Args: |
| name: string, Required. The name of the resource. For the required format, see the comment on the User.name field. (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 ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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). |
| validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it. |
| 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 User. |
| |
| Args: |
| name: string, Required. The name of the resource. For the required format, see the comment on the User.name field. (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 User object. |
| "databaseRoles": [ # Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
| "A String", |
| ], |
| "keepExtraRoles": True or False, # Input only. If the user already exists and it has additional roles, keep them granted. |
| "name": "A String", # Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
| "password": "A String", # Input only. Password for the user. |
| "userType": "A String", # Optional. Type of this user. |
| }</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 Users in a given project and location. |
| |
| Args: |
| parent: string, Required. Parent value for ListUsersRequest (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 Users |
| "nextPageToken": "A String", # A token identifying a page of results the server should return. |
| "unreachable": [ # Locations that could not be reached. |
| "A String", |
| ], |
| "users": [ # The list of User |
| { # Message describing User object. |
| "databaseRoles": [ # Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
| "A String", |
| ], |
| "keepExtraRoles": True or False, # Input only. If the user already exists and it has additional roles, keep them granted. |
| "name": "A String", # Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
| "password": "A String", # Input only. Password for the user. |
| "userType": "A String", # Optional. Type of this user. |
| }, |
| ], |
| }</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, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code> |
| <pre>Updates the parameters of a single User. |
| |
| Args: |
| name: string, Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Message describing User object. |
| "databaseRoles": [ # Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
| "A String", |
| ], |
| "keepExtraRoles": True or False, # Input only. If the user already exists and it has additional roles, keep them granted. |
| "name": "A String", # Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
| "password": "A String", # Input only. Password for the user. |
| "userType": "A String", # Optional. Type of this user. |
| } |
| |
| allowMissing: boolean, Optional. Allow missing fields in the update mask. |
| 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 ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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 User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
| validateOnly: boolean, Optional. If set, the backend validates the request, but doesn't actually execute it. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message describing User object. |
| "databaseRoles": [ # Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
| "A String", |
| ], |
| "keepExtraRoles": True or False, # Input only. If the user already exists and it has additional roles, keep them granted. |
| "name": "A String", # Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
| "password": "A String", # Input only. Password for the user. |
| "userType": "A String", # Optional. Type of this user. |
| }</pre> |
| </div> |
| |
| </body></html> |
