| <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="cloudresourcemanager_v1beta1.html">Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.projects.html">projects</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(body=None, useLegacyStack=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a Project resource.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Marks the Project identified by the specified</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(projectId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the Project identified by the specified</p> |
| <p class="toc_element"> |
| <code><a href="#getAncestry">getAncestry(projectId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p> |
| <p class="toc_element"> |
| <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the IAM access control policy for the specified Project.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists Projects that the caller has the `resourcemanager.projects.get`</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="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the IAM access control policy for the specified Project.</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns permissions that a caller has on the specified Project.</p> |
| <p class="toc_element"> |
| <code><a href="#undelete">undelete(projectId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Restores the Project identified by the specified</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(projectId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the attributes of the Project identified by the specified</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(body=None, useLegacyStack=None, x__xgafv=None)</code> |
| <pre>Creates a Project resource. |
| |
| Initially, the Project resource is owned by its creator exclusively. |
| The creator can later grant permission to others to read or update the |
| Project. |
| |
| Several APIs are activated automatically for the Project, including |
| Google Cloud Storage. The parent is identified by a specified |
| ResourceId, which must include both an ID and a type, such as |
| project, folder, or organization. |
| |
| This method does not associate the new project with a billing account. |
| You can set or update the billing account associated with a project using |
| the [`projects.updateBillingInfo`] |
| (/billing/reference/rest/v1/projects/updateBillingInfo) method. |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A Project is a high-level Google Cloud Platform entity. It is a |
| # container for ACLs, APIs, App Engine Apps, VMs, and other |
| # Google Cloud Platform resources. |
| "projectId": "A String", # The unique, user-assigned ID of the Project. |
| # It must be 6 to 30 lowercase letters, digits, or hyphens. |
| # It must start with a letter. |
| # Trailing hyphens are prohibited. |
| # |
| # Example: <code>tokyo-rain-123</code> |
| # Read-only after creation. |
| "labels": { # The labels associated with this Project. |
| # |
| # Label keys must be between 1 and 63 characters long and must conform |
| # to the following regular expression: a-z{0,62}. |
| # |
| # Label values must be between 0 and 63 characters long and must conform |
| # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. |
| # |
| # No more than 256 labels can be associated with a given resource. |
| # |
| # Clients should store labels in a representation such as JSON that does not |
| # depend on specific characters being disallowed. |
| # |
| # Example: <code>"environment" : "dev"</code> |
| # Read-write. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Creation time. |
| # |
| # Read-only. |
| "projectNumber": "A String", # The number uniquely identifying the project. |
| # |
| # Example: <code>415104041262</code> |
| # Read-only. |
| "lifecycleState": "A String", # The Project lifecycle state. |
| # |
| # Read-only. |
| "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource. |
| # |
| # Supported parent types include "organization" and "folder". Once set, the |
| # parent cannot be cleared. The `parent` can be set on creation or using the |
| # `UpdateProject` method; the end user must have the |
| # `resourcemanager.projects.create` permission on the parent. |
| # |
| # Read-write. |
| # Cloud Platform is a generic term for something you (a developer) may want to |
| # interact with through one of our API's. Some examples are an App Engine app, |
| # a Compute Engine instance, a Cloud SQL database, and so on. |
| "id": "A String", # Required field for the type-specific id. This should correspond to the id |
| # used in the type-specific API's. |
| "type": "A String", # Required field representing the resource type this id is for. |
| # At present, the valid types are "project", "folder", and "organization". |
| }, |
| "name": "A String", # The optional user-assigned display name of the Project. |
| # When present it must be between 4 to 30 characters. |
| # Allowed characters are: lowercase and uppercase letters, numbers, |
| # hyphen, single-quote, double-quote, space, and exclamation point. |
| # |
| # Example: <code>My Project</code> |
| # Read-write. |
| } |
| |
| useLegacyStack: boolean, A now unused experiment opt-out option. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Project is a high-level Google Cloud Platform entity. It is a |
| # container for ACLs, APIs, App Engine Apps, VMs, and other |
| # Google Cloud Platform resources. |
| "projectId": "A String", # The unique, user-assigned ID of the Project. |
| # It must be 6 to 30 lowercase letters, digits, or hyphens. |
| # It must start with a letter. |
| # Trailing hyphens are prohibited. |
| # |
| # Example: <code>tokyo-rain-123</code> |
| # Read-only after creation. |
| "labels": { # The labels associated with this Project. |
| # |
| # Label keys must be between 1 and 63 characters long and must conform |
| # to the following regular expression: a-z{0,62}. |
| # |
| # Label values must be between 0 and 63 characters long and must conform |
| # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. |
| # |
| # No more than 256 labels can be associated with a given resource. |
| # |
| # Clients should store labels in a representation such as JSON that does not |
| # depend on specific characters being disallowed. |
| # |
| # Example: <code>"environment" : "dev"</code> |
| # Read-write. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Creation time. |
| # |
| # Read-only. |
| "projectNumber": "A String", # The number uniquely identifying the project. |
| # |
| # Example: <code>415104041262</code> |
| # Read-only. |
| "lifecycleState": "A String", # The Project lifecycle state. |
| # |
| # Read-only. |
| "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource. |
| # |
| # Supported parent types include "organization" and "folder". Once set, the |
| # parent cannot be cleared. The `parent` can be set on creation or using the |
| # `UpdateProject` method; the end user must have the |
| # `resourcemanager.projects.create` permission on the parent. |
| # |
| # Read-write. |
| # Cloud Platform is a generic term for something you (a developer) may want to |
| # interact with through one of our API's. Some examples are an App Engine app, |
| # a Compute Engine instance, a Cloud SQL database, and so on. |
| "id": "A String", # Required field for the type-specific id. This should correspond to the id |
| # used in the type-specific API's. |
| "type": "A String", # Required field representing the resource type this id is for. |
| # At present, the valid types are "project", "folder", and "organization". |
| }, |
| "name": "A String", # The optional user-assigned display name of the Project. |
| # When present it must be between 4 to 30 characters. |
| # Allowed characters are: lowercase and uppercase letters, numbers, |
| # hyphen, single-quote, double-quote, space, and exclamation point. |
| # |
| # Example: <code>My Project</code> |
| # Read-write. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(projectId, x__xgafv=None)</code> |
| <pre>Marks the Project identified by the specified |
| `project_id` (for example, `my-project-123`) for deletion. |
| This method will only affect the Project if it has a lifecycle state of |
| ACTIVE. |
| |
| This method changes the Project's lifecycle state from |
| ACTIVE |
| to DELETE_REQUESTED. |
| The deletion starts at an unspecified time, at which point the project is |
| no longer accessible. |
| |
| Until the deletion completes, you can check the lifecycle state |
| checked by retrieving the Project with GetProject, |
| and the Project remains visible to ListProjects. |
| However, you cannot update the project. |
| |
| After the deletion completes, the Project is not retrievable by |
| the GetProject |
| and ListProjects |
| methods. |
| |
| The caller must have modify permissions for this Project. |
| |
| Args: |
| projectId: string, The Project ID (for example, `foo-bar-123`). |
| |
| Required. (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(projectId, x__xgafv=None)</code> |
| <pre>Retrieves the Project identified by the specified |
| `project_id` (for example, `my-project-123`). |
| |
| The caller must have read permissions for this Project. |
| |
| Args: |
| projectId: string, The Project ID (for example, `my-project-123`). |
| |
| Required. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Project is a high-level Google Cloud Platform entity. It is a |
| # container for ACLs, APIs, App Engine Apps, VMs, and other |
| # Google Cloud Platform resources. |
| "projectId": "A String", # The unique, user-assigned ID of the Project. |
| # It must be 6 to 30 lowercase letters, digits, or hyphens. |
| # It must start with a letter. |
| # Trailing hyphens are prohibited. |
| # |
| # Example: <code>tokyo-rain-123</code> |
| # Read-only after creation. |
| "labels": { # The labels associated with this Project. |
| # |
| # Label keys must be between 1 and 63 characters long and must conform |
| # to the following regular expression: a-z{0,62}. |
| # |
| # Label values must be between 0 and 63 characters long and must conform |
| # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. |
| # |
| # No more than 256 labels can be associated with a given resource. |
| # |
| # Clients should store labels in a representation such as JSON that does not |
| # depend on specific characters being disallowed. |
| # |
| # Example: <code>"environment" : "dev"</code> |
| # Read-write. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Creation time. |
| # |
| # Read-only. |
| "projectNumber": "A String", # The number uniquely identifying the project. |
| # |
| # Example: <code>415104041262</code> |
| # Read-only. |
| "lifecycleState": "A String", # The Project lifecycle state. |
| # |
| # Read-only. |
| "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource. |
| # |
| # Supported parent types include "organization" and "folder". Once set, the |
| # parent cannot be cleared. The `parent` can be set on creation or using the |
| # `UpdateProject` method; the end user must have the |
| # `resourcemanager.projects.create` permission on the parent. |
| # |
| # Read-write. |
| # Cloud Platform is a generic term for something you (a developer) may want to |
| # interact with through one of our API's. Some examples are an App Engine app, |
| # a Compute Engine instance, a Cloud SQL database, and so on. |
| "id": "A String", # Required field for the type-specific id. This should correspond to the id |
| # used in the type-specific API's. |
| "type": "A String", # Required field representing the resource type this id is for. |
| # At present, the valid types are "project", "folder", and "organization". |
| }, |
| "name": "A String", # The optional user-assigned display name of the Project. |
| # When present it must be between 4 to 30 characters. |
| # Allowed characters are: lowercase and uppercase letters, numbers, |
| # hyphen, single-quote, double-quote, space, and exclamation point. |
| # |
| # Example: <code>My Project</code> |
| # Read-write. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getAncestry">getAncestry(projectId, body=None, x__xgafv=None)</code> |
| <pre>Gets a list of ancestors in the resource hierarchy for the Project |
| identified by the specified `project_id` (for example, `my-project-123`). |
| |
| The caller must have read permissions for this Project. |
| |
| Args: |
| projectId: string, The Project ID (for example, `my-project-123`). |
| |
| Required. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The request sent to the |
| # [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetAncestry] |
| # method. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response from the |
| # projects.getAncestry |
| # method. |
| "ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The |
| # first ancestor is the project itself, followed by the project's parent, |
| # etc. |
| { # Identifying information for a single ancestor of a project. |
| "resourceId": { # A container to reference an id for any resource type. A `resource` in Google # Resource id of the ancestor. |
| # Cloud Platform is a generic term for something you (a developer) may want to |
| # interact with through one of our API's. Some examples are an App Engine app, |
| # a Compute Engine instance, a Cloud SQL database, and so on. |
| "id": "A String", # Required field for the type-specific id. This should correspond to the id |
| # used in the type-specific API's. |
| "type": "A String", # Required field representing the resource type this id is for. |
| # At present, the valid types are "project", "folder", and "organization". |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> |
| <pre>Returns the IAM access control policy for the specified Project. |
| Permission is denied if the policy or the resource does not exist. |
| |
| For additional information about resource structure and identification, |
| see [Resource Names](/apis/design/resource_names). |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `GetIamPolicy` method. |
| "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to |
| # `GetIamPolicy`. |
| "requestedPolicyVersion": 42, # Optional. The policy format version to be returned. |
| # |
| # Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| # rejected. |
| # |
| # Requests for policies with any conditional bindings must specify version 3. |
| # Policies without any conditional bindings may specify any valid value or |
| # leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| }, |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| "logType": "A String", # The log type that this config enables. |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists Projects that the caller has the `resourcemanager.projects.get` |
| permission on and satisfy the specified filter. |
| |
| This method returns Projects in an unspecified order. |
| This method is eventually consistent with project mutations; this means |
| that a newly created project may not appear in the results or recent |
| updates to an existing project may not be reflected in the results. To |
| retrieve the latest state of a project, use the |
| GetProject method. |
| |
| NOTE: If the request filter contains a `parent.type` and `parent.id` and |
| the caller has the `resourcemanager.projects.list` permission on the |
| parent, the results will be drawn from an alternate index which provides |
| more consistent results. In future versions of this API, this List method |
| will be split into List and Search to properly capture the behavorial |
| difference. |
| |
| Args: |
| filter: string, An expression for filtering the results of the request. Filter rules are |
| case insensitive. The fields eligible for filtering are: |
| |
| + `name` |
| + `id` |
| + `labels.<key>` (where *key* is the name of a label) |
| + `parent.type` |
| + `parent.id` |
| |
| Some examples of using labels as filters: |
| |
| | Filter | Description | |
| |------------------|-----------------------------------------------------| |
| | name:how* | The project's name starts with "how". | |
| | name:Howl | The project's name is `Howl` or `howl`. | |
| | name:HOWL | Equivalent to above. | |
| | NAME:howl | Equivalent to above. | |
| | labels.color:* | The project has the label `color`. | |
| | labels.color:red | The project's label `color` has the value `red`. | |
| | labels.color:red&nbsp;labels.size:big |The project's label `color` has |
| the value `red` and its label `size` has the value `big`. | |
| |
| If no filter is specified, the call will return projects for which the user |
| has the `resourcemanager.projects.get` permission. |
| |
| NOTE: To perform a by-parent query (eg., what projects are directly in a |
| Folder), the caller must have the `resourcemanager.projects.list` |
| permission on the parent and the filter must contain both a `parent.type` |
| and a `parent.id` restriction |
| (example: "parent.type:folder parent.id:123"). In this case an alternate |
| search index is used which provides more consistent results. |
| |
| Optional. |
| pageSize: integer, The maximum number of Projects to return in the response. |
| The server can return fewer Projects than requested. |
| If unspecified, server picks an appropriate default. |
| |
| Optional. |
| pageToken: string, A pagination token returned from a previous call to ListProjects |
| that indicates from where listing should continue. |
| |
| Optional. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A page of the response received from the |
| # ListProjects |
| # method. |
| # |
| # A paginated response where more pages are available has |
| # `next_page_token` set. This token can be used in a subsequent request to |
| # retrieve the next request page. |
| "nextPageToken": "A String", # Pagination token. |
| # |
| # If the result set is too large to fit in a single response, this token |
| # is returned. It encodes the position of the current result cursor. |
| # Feeding this value into a new list request with the `page_token` parameter |
| # gives the next page of the results. |
| # |
| # When `next_page_token` is not filled in, there is no next page and |
| # the list returned is the last page in the result set. |
| # |
| # Pagination tokens have a limited lifetime. |
| "projects": [ # The list of Projects that matched the list filter. This list can |
| # be paginated. |
| { # A Project is a high-level Google Cloud Platform entity. It is a |
| # container for ACLs, APIs, App Engine Apps, VMs, and other |
| # Google Cloud Platform resources. |
| "projectId": "A String", # The unique, user-assigned ID of the Project. |
| # It must be 6 to 30 lowercase letters, digits, or hyphens. |
| # It must start with a letter. |
| # Trailing hyphens are prohibited. |
| # |
| # Example: <code>tokyo-rain-123</code> |
| # Read-only after creation. |
| "labels": { # The labels associated with this Project. |
| # |
| # Label keys must be between 1 and 63 characters long and must conform |
| # to the following regular expression: a-z{0,62}. |
| # |
| # Label values must be between 0 and 63 characters long and must conform |
| # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. |
| # |
| # No more than 256 labels can be associated with a given resource. |
| # |
| # Clients should store labels in a representation such as JSON that does not |
| # depend on specific characters being disallowed. |
| # |
| # Example: <code>"environment" : "dev"</code> |
| # Read-write. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Creation time. |
| # |
| # Read-only. |
| "projectNumber": "A String", # The number uniquely identifying the project. |
| # |
| # Example: <code>415104041262</code> |
| # Read-only. |
| "lifecycleState": "A String", # The Project lifecycle state. |
| # |
| # Read-only. |
| "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource. |
| # |
| # Supported parent types include "organization" and "folder". Once set, the |
| # parent cannot be cleared. The `parent` can be set on creation or using the |
| # `UpdateProject` method; the end user must have the |
| # `resourcemanager.projects.create` permission on the parent. |
| # |
| # Read-write. |
| # Cloud Platform is a generic term for something you (a developer) may want to |
| # interact with through one of our API's. Some examples are an App Engine app, |
| # a Compute Engine instance, a Cloud SQL database, and so on. |
| "id": "A String", # Required field for the type-specific id. This should correspond to the id |
| # used in the type-specific API's. |
| "type": "A String", # Required field representing the resource type this id is for. |
| # At present, the valid types are "project", "folder", and "organization". |
| }, |
| "name": "A String", # The optional user-assigned display name of the Project. |
| # When present it must be between 4 to 30 characters. |
| # Allowed characters are: lowercase and uppercase letters, numbers, |
| # hyphen, single-quote, double-quote, space, and exclamation point. |
| # |
| # Example: <code>My Project</code> |
| # Read-write. |
| }, |
| ], |
| }</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="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| <pre>Sets the IAM access control policy for the specified Project. |
| |
| CAUTION: This method will replace the existing policy, and cannot be used |
| to append additional IAM settings. |
| |
| NOTE: Removing service accounts from policies or changing their roles can |
| render services completely inoperable. It is important to understand how |
| the service account is being used before removing or updating its roles. |
| |
| The following constraints apply when using `setIamPolicy()`: |
| |
| + Project does not support `allUsers` and `allAuthenticatedUsers` as |
| `members` in a `Binding` of a `Policy`. |
| |
| + The owner role can be granted to a `user`, `serviceAccount`, or a group |
| that is part of an organization. For example, |
| group@myownpersonaldomain.com could be added as an owner to a project in |
| the myownpersonaldomain.com organization, but not the examplepetstore.com |
| organization. |
| |
| + Service accounts can be made owners of a project directly |
| without any restrictions. However, to be added as an owner, a user must be |
| invited via Cloud Platform console and must accept the invitation. |
| |
| + A user cannot be granted the owner role using `setIamPolicy()`. The user |
| must be granted the owner role using the Cloud Platform Console and must |
| explicitly accept the invitation. |
| |
| + Invitations to grant the owner role cannot be sent using |
| `setIamPolicy()`; they must be sent only using the Cloud Platform Console. |
| |
| + Membership changes that leave the project without any owners that have |
| accepted the Terms of Service (ToS) will be rejected. |
| |
| + If the project is not part of an organization, there must be at least |
| one owner who has accepted the Terms of Service (ToS) agreement in the |
| policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner |
| from the policy will fail. This restriction also applies to legacy |
| projects that no longer have owners who have accepted the ToS. Edits to |
| IAM policies will be rejected until the lack of a ToS-accepting owner is |
| rectified. |
| |
| Authorization requires the Google IAM permission |
| `resourcemanager.projects.setIamPolicy` on the project |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being specified. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `SetIamPolicy` method. |
| "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only |
| # the fields in the mask will be modified. If no mask is provided, the |
| # following default mask is used: |
| # |
| # `paths: "bindings, etag"` |
| "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| # the policy is limited to a few 10s of KB. An empty policy is a |
| # valid policy but certain Cloud Platform services (such as Projects) |
| # might reject them. |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| }, |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| "logType": "A String", # The log type that this config enables. |
| }, |
| ], |
| }, |
| ], |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| }, |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| "logType": "A String", # The log type that this config enables. |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified Project. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `TestIamPermissions` method. |
| "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| # information see |
| # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for `TestIamPermissions` method. |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="undelete">undelete(projectId, body=None, x__xgafv=None)</code> |
| <pre>Restores the Project identified by the specified |
| `project_id` (for example, `my-project-123`). |
| You can only use this method for a Project that has a lifecycle state of |
| DELETE_REQUESTED. |
| After deletion starts, the Project cannot be restored. |
| |
| The caller must have modify permissions for this Project. |
| |
| Args: |
| projectId: string, The project ID (for example, `foo-bar-123`). |
| |
| Required. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The request sent to the UndeleteProject |
| # method. |
| } |
| |
| 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="update">update(projectId, body=None, x__xgafv=None)</code> |
| <pre>Updates the attributes of the Project identified by the specified |
| `project_id` (for example, `my-project-123`). |
| |
| The caller must have modify permissions for this Project. |
| |
| Args: |
| projectId: string, The project ID (for example, `my-project-123`). |
| |
| Required. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A Project is a high-level Google Cloud Platform entity. It is a |
| # container for ACLs, APIs, App Engine Apps, VMs, and other |
| # Google Cloud Platform resources. |
| "projectId": "A String", # The unique, user-assigned ID of the Project. |
| # It must be 6 to 30 lowercase letters, digits, or hyphens. |
| # It must start with a letter. |
| # Trailing hyphens are prohibited. |
| # |
| # Example: <code>tokyo-rain-123</code> |
| # Read-only after creation. |
| "labels": { # The labels associated with this Project. |
| # |
| # Label keys must be between 1 and 63 characters long and must conform |
| # to the following regular expression: a-z{0,62}. |
| # |
| # Label values must be between 0 and 63 characters long and must conform |
| # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. |
| # |
| # No more than 256 labels can be associated with a given resource. |
| # |
| # Clients should store labels in a representation such as JSON that does not |
| # depend on specific characters being disallowed. |
| # |
| # Example: <code>"environment" : "dev"</code> |
| # Read-write. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Creation time. |
| # |
| # Read-only. |
| "projectNumber": "A String", # The number uniquely identifying the project. |
| # |
| # Example: <code>415104041262</code> |
| # Read-only. |
| "lifecycleState": "A String", # The Project lifecycle state. |
| # |
| # Read-only. |
| "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource. |
| # |
| # Supported parent types include "organization" and "folder". Once set, the |
| # parent cannot be cleared. The `parent` can be set on creation or using the |
| # `UpdateProject` method; the end user must have the |
| # `resourcemanager.projects.create` permission on the parent. |
| # |
| # Read-write. |
| # Cloud Platform is a generic term for something you (a developer) may want to |
| # interact with through one of our API's. Some examples are an App Engine app, |
| # a Compute Engine instance, a Cloud SQL database, and so on. |
| "id": "A String", # Required field for the type-specific id. This should correspond to the id |
| # used in the type-specific API's. |
| "type": "A String", # Required field representing the resource type this id is for. |
| # At present, the valid types are "project", "folder", and "organization". |
| }, |
| "name": "A String", # The optional user-assigned display name of the Project. |
| # When present it must be between 4 to 30 characters. |
| # Allowed characters are: lowercase and uppercase letters, numbers, |
| # hyphen, single-quote, double-quote, space, and exclamation point. |
| # |
| # Example: <code>My Project</code> |
| # Read-write. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Project is a high-level Google Cloud Platform entity. It is a |
| # container for ACLs, APIs, App Engine Apps, VMs, and other |
| # Google Cloud Platform resources. |
| "projectId": "A String", # The unique, user-assigned ID of the Project. |
| # It must be 6 to 30 lowercase letters, digits, or hyphens. |
| # It must start with a letter. |
| # Trailing hyphens are prohibited. |
| # |
| # Example: <code>tokyo-rain-123</code> |
| # Read-only after creation. |
| "labels": { # The labels associated with this Project. |
| # |
| # Label keys must be between 1 and 63 characters long and must conform |
| # to the following regular expression: a-z{0,62}. |
| # |
| # Label values must be between 0 and 63 characters long and must conform |
| # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. |
| # |
| # No more than 256 labels can be associated with a given resource. |
| # |
| # Clients should store labels in a representation such as JSON that does not |
| # depend on specific characters being disallowed. |
| # |
| # Example: <code>"environment" : "dev"</code> |
| # Read-write. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Creation time. |
| # |
| # Read-only. |
| "projectNumber": "A String", # The number uniquely identifying the project. |
| # |
| # Example: <code>415104041262</code> |
| # Read-only. |
| "lifecycleState": "A String", # The Project lifecycle state. |
| # |
| # Read-only. |
| "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource. |
| # |
| # Supported parent types include "organization" and "folder". Once set, the |
| # parent cannot be cleared. The `parent` can be set on creation or using the |
| # `UpdateProject` method; the end user must have the |
| # `resourcemanager.projects.create` permission on the parent. |
| # |
| # Read-write. |
| # Cloud Platform is a generic term for something you (a developer) may want to |
| # interact with through one of our API's. Some examples are an App Engine app, |
| # a Compute Engine instance, a Cloud SQL database, and so on. |
| "id": "A String", # Required field for the type-specific id. This should correspond to the id |
| # used in the type-specific API's. |
| "type": "A String", # Required field representing the resource type this id is for. |
| # At present, the valid types are "project", "folder", and "organization". |
| }, |
| "name": "A String", # The optional user-assigned display name of the Project. |
| # When present it must be between 4 to 30 characters. |
| # Allowed characters are: lowercase and uppercase letters, numbers, |
| # hyphen, single-quote, double-quote, space, and exclamation point. |
| # |
| # Example: <code>My Project</code> |
| # Read-write. |
| }</pre> |
| </div> |
| |
| </body></html> |
