docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/sourcerepo_v1.projects.repos.html b/docs/dyn/sourcerepo_v1.projects.repos.html
index f1f586e..22a65b9 100644
--- a/docs/dyn/sourcerepo_v1.projects.repos.html
+++ b/docs/dyn/sourcerepo_v1.projects.repos.html
@@ -87,7 +87,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource.</p>
<p class="toc_element">
- <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(name, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns all repos belonging to a project. The sizes of the repos are</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -119,39 +119,39 @@
The object takes the form of:
{ # A repository (or repo) is a Git repository storing versioned source content.
- "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
# Read-only field.
- "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
+ # hosting service, for example GitHub or Bitbucket.
+ "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
+ # Removing this key from the other service would deauthorize
+ # Google Cloud Source Repositories from mirroring.
+ "url": "A String", # URL of the main repository at the other hosting service.
+ "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
+ # Removing this webhook from the other hosting service will stop
+ # Google Cloud Source Repositories from receiving notifications,
+ # and thereby disabling mirroring.
+ },
+ "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ # Read-only field.
+ "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
# Pub/Sub. Keyed by the topic names.
- "a_key": { # Configuration to publish a Cloud Pub/Sub message.
- "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
- # `projects/<project>/topics/<topic>`. The project needs to be the same
- # project as this config is in.
- "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
+ "a_key": { # Configuration to publish a Cloud Pub/Sub message.
+ "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
# messages. This service account needs to be in the same project as the
# PubsubConfig. When added, the caller needs to have
# iam.serviceAccounts.actAs permission on this service account. If
# unspecified, it defaults to the compute engine default service account.
- "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
+ # `projects/<project>/topics/<topic>`. The project needs to be the same
+ # project as this config is in.
},
},
- "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
+ "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
# returned by GetRepo.
- "name": "A String", # Resource name of the repository, of the form
+ "name": "A String", # Resource name of the repository, of the form
# `projects/<project>/repos/<repo>`. The repo name may contain slashes.
# eg, `projects/myproject/repos/name/with/slash`
- "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
- # Read-only field.
- # hosting service, for example GitHub or Bitbucket.
- "url": "A String", # URL of the main repository at the other hosting service.
- "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
- # Removing this webhook from the other hosting service will stop
- # Google Cloud Source Repositories from receiving notifications,
- # and thereby disabling mirroring.
- "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
- # Removing this key from the other service would deauthorize
- # Google Cloud Source Repositories from mirroring.
- },
}
x__xgafv: string, V1 error format.
@@ -163,39 +163,39 @@
An object of the form:
{ # A repository (or repo) is a Git repository storing versioned source content.
- "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
# Read-only field.
- "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
+ # hosting service, for example GitHub or Bitbucket.
+ "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
+ # Removing this key from the other service would deauthorize
+ # Google Cloud Source Repositories from mirroring.
+ "url": "A String", # URL of the main repository at the other hosting service.
+ "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
+ # Removing this webhook from the other hosting service will stop
+ # Google Cloud Source Repositories from receiving notifications,
+ # and thereby disabling mirroring.
+ },
+ "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ # Read-only field.
+ "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
# Pub/Sub. Keyed by the topic names.
- "a_key": { # Configuration to publish a Cloud Pub/Sub message.
- "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
- # `projects/<project>/topics/<topic>`. The project needs to be the same
- # project as this config is in.
- "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
+ "a_key": { # Configuration to publish a Cloud Pub/Sub message.
+ "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
# messages. This service account needs to be in the same project as the
# PubsubConfig. When added, the caller needs to have
# iam.serviceAccounts.actAs permission on this service account. If
# unspecified, it defaults to the compute engine default service account.
- "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
+ # `projects/<project>/topics/<topic>`. The project needs to be the same
+ # project as this config is in.
},
},
- "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
+ "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
# returned by GetRepo.
- "name": "A String", # Resource name of the repository, of the form
+ "name": "A String", # Resource name of the repository, of the form
# `projects/<project>/repos/<repo>`. The repo name may contain slashes.
# eg, `projects/myproject/repos/name/with/slash`
- "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
- # Read-only field.
- # hosting service, for example GitHub or Bitbucket.
- "url": "A String", # URL of the main repository at the other hosting service.
- "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
- # Removing this webhook from the other hosting service will stop
- # Google Cloud Source Repositories from receiving notifications,
- # and thereby disabling mirroring.
- "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
- # Removing this key from the other service would deauthorize
- # Google Cloud Source Repositories from mirroring.
- },
}</pre>
</div>
@@ -242,39 +242,39 @@
An object of the form:
{ # A repository (or repo) is a Git repository storing versioned source content.
- "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
# Read-only field.
- "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
+ # hosting service, for example GitHub or Bitbucket.
+ "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
+ # Removing this key from the other service would deauthorize
+ # Google Cloud Source Repositories from mirroring.
+ "url": "A String", # URL of the main repository at the other hosting service.
+ "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
+ # Removing this webhook from the other hosting service will stop
+ # Google Cloud Source Repositories from receiving notifications,
+ # and thereby disabling mirroring.
+ },
+ "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ # Read-only field.
+ "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
# Pub/Sub. Keyed by the topic names.
- "a_key": { # Configuration to publish a Cloud Pub/Sub message.
- "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
- # `projects/<project>/topics/<topic>`. The project needs to be the same
- # project as this config is in.
- "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
+ "a_key": { # Configuration to publish a Cloud Pub/Sub message.
+ "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
# messages. This service account needs to be in the same project as the
# PubsubConfig. When added, the caller needs to have
# iam.serviceAccounts.actAs permission on this service account. If
# unspecified, it defaults to the compute engine default service account.
- "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
+ # `projects/<project>/topics/<topic>`. The project needs to be the same
+ # project as this config is in.
},
},
- "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
+ "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
# returned by GetRepo.
- "name": "A String", # Resource name of the repository, of the form
+ "name": "A String", # Resource name of the repository, of the form
# `projects/<project>/repos/<repo>`. The repo name may contain slashes.
# eg, `projects/myproject/repos/name/with/slash`
- "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
- # Read-only field.
- # hosting service, for example GitHub or Bitbucket.
- "url": "A String", # URL of the main repository at the other hosting service.
- "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
- # Removing this webhook from the other hosting service will stop
- # Google Cloud Source Repositories from receiving notifications,
- # and thereby disabling mirroring.
- "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
- # Removing this key from the other service would deauthorize
- # Google Cloud Source Repositories from mirroring.
- },
}</pre>
</div>
@@ -321,28 +321,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "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.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')",
+ # "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
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -360,19 +360,135 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # 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/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "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.
+ "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.
+ "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.
+ "logType": "A String", # The log type that this config enables.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ },
+ ],
+ "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.
+ },
+ ],
+ "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`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "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
@@ -415,9 +531,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ "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.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
@@ -426,166 +544,48 @@
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # 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"
+ # 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'"
+ # 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)"
+ # 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.
- "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.
- "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
+ "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.
+ "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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
},
],
- "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.
- "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.
- },
- ],
- "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.
- },
- ],
- "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(name, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Returns all repos belonging to a project. The sizes of the repos are
not set by ListRepos. To get the size of a repo, use GetRepo.
@@ -594,58 +594,58 @@
`projects/<project>`. (required)
pageToken: string, Resume listing repositories where a prior ListReposResponse
left off. This is an opaque token that must be obtained from
-a recent, prior ListReposResponse's next_page_token field.
+a recent, prior ListReposResponse's next_page_token field.
+ pageSize: integer, Maximum number of repositories to return; between 1 and 500.
+If not set or zero, defaults to 100 at the server.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, Maximum number of repositories to return; between 1 and 500.
-If not set or zero, defaults to 100 at the server.
Returns:
An object of the form:
{ # Response for ListRepos. The size is not set in the returned repositories.
- "nextPageToken": "A String", # If non-empty, additional repositories exist within the project. These
- # can be retrieved by including this value in the next ListReposRequest's
- # page_token field.
- "repos": [ # The listed repos.
+ "repos": [ # The listed repos.
{ # A repository (or repo) is a Git repository storing versioned source content.
- "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
# Read-only field.
- "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
+ # hosting service, for example GitHub or Bitbucket.
+ "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
+ # Removing this key from the other service would deauthorize
+ # Google Cloud Source Repositories from mirroring.
+ "url": "A String", # URL of the main repository at the other hosting service.
+ "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
+ # Removing this webhook from the other hosting service will stop
+ # Google Cloud Source Repositories from receiving notifications,
+ # and thereby disabling mirroring.
+ },
+ "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ # Read-only field.
+ "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
# Pub/Sub. Keyed by the topic names.
- "a_key": { # Configuration to publish a Cloud Pub/Sub message.
- "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
- # `projects/<project>/topics/<topic>`. The project needs to be the same
- # project as this config is in.
- "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
+ "a_key": { # Configuration to publish a Cloud Pub/Sub message.
+ "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
# messages. This service account needs to be in the same project as the
# PubsubConfig. When added, the caller needs to have
# iam.serviceAccounts.actAs permission on this service account. If
# unspecified, it defaults to the compute engine default service account.
- "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
+ # `projects/<project>/topics/<topic>`. The project needs to be the same
+ # project as this config is in.
},
},
- "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
+ "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
# returned by GetRepo.
- "name": "A String", # Resource name of the repository, of the form
+ "name": "A String", # Resource name of the repository, of the form
# `projects/<project>/repos/<repo>`. The repo name may contain slashes.
# eg, `projects/myproject/repos/name/with/slash`
- "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
- # Read-only field.
- # hosting service, for example GitHub or Bitbucket.
- "url": "A String", # URL of the main repository at the other hosting service.
- "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
- # Removing this webhook from the other hosting service will stop
- # Google Cloud Source Repositories from receiving notifications,
- # and thereby disabling mirroring.
- "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
- # Removing this key from the other service would deauthorize
- # Google Cloud Source Repositories from mirroring.
- },
},
],
+ "nextPageToken": "A String", # If non-empty, additional repositories exist within the project. These
+ # can be retrieved by including this value in the next ListReposRequest's
+ # page_token field.
}</pre>
</div>
@@ -658,7 +658,7 @@
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
+ 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>
@@ -674,42 +674,42 @@
The object takes the form of:
{ # Request for UpdateRepo.
- "repo": { # A repository (or repo) is a Git repository storing versioned source content. # The new configuration for the repository.
- "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ "repo": { # A repository (or repo) is a Git repository storing versioned source content. # The new configuration for the repository.
+ "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
# Read-only field.
- "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
+ # hosting service, for example GitHub or Bitbucket.
+ "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
+ # Removing this key from the other service would deauthorize
+ # Google Cloud Source Repositories from mirroring.
+ "url": "A String", # URL of the main repository at the other hosting service.
+ "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
+ # Removing this webhook from the other hosting service will stop
+ # Google Cloud Source Repositories from receiving notifications,
+ # and thereby disabling mirroring.
+ },
+ "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ # Read-only field.
+ "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
# Pub/Sub. Keyed by the topic names.
- "a_key": { # Configuration to publish a Cloud Pub/Sub message.
- "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
- # `projects/<project>/topics/<topic>`. The project needs to be the same
- # project as this config is in.
- "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
+ "a_key": { # Configuration to publish a Cloud Pub/Sub message.
+ "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
# messages. This service account needs to be in the same project as the
# PubsubConfig. When added, the caller needs to have
# iam.serviceAccounts.actAs permission on this service account. If
# unspecified, it defaults to the compute engine default service account.
- "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
+ # `projects/<project>/topics/<topic>`. The project needs to be the same
+ # project as this config is in.
},
},
- "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
+ "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
# returned by GetRepo.
- "name": "A String", # Resource name of the repository, of the form
+ "name": "A String", # Resource name of the repository, of the form
# `projects/<project>/repos/<repo>`. The repo name may contain slashes.
# eg, `projects/myproject/repos/name/with/slash`
- "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
- # Read-only field.
- # hosting service, for example GitHub or Bitbucket.
- "url": "A String", # URL of the main repository at the other hosting service.
- "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
- # Removing this webhook from the other hosting service will stop
- # Google Cloud Source Repositories from receiving notifications,
- # and thereby disabling mirroring.
- "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
- # Removing this key from the other service would deauthorize
- # Google Cloud Source Repositories from mirroring.
- },
},
- "updateMask": "A String", # A FieldMask specifying which fields of the repo to modify. Only the fields
+ "updateMask": "A String", # A FieldMask specifying which fields of the repo to modify. Only the fields
# in the mask will be modified. If no mask is provided, this request is
# no-op.
}
@@ -723,39 +723,39 @@
An object of the form:
{ # A repository (or repo) is a Git repository storing versioned source content.
- "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
# Read-only field.
- "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
+ # hosting service, for example GitHub or Bitbucket.
+ "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
+ # Removing this key from the other service would deauthorize
+ # Google Cloud Source Repositories from mirroring.
+ "url": "A String", # URL of the main repository at the other hosting service.
+ "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
+ # Removing this webhook from the other hosting service will stop
+ # Google Cloud Source Repositories from receiving notifications,
+ # and thereby disabling mirroring.
+ },
+ "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
+ # Read-only field.
+ "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
# Pub/Sub. Keyed by the topic names.
- "a_key": { # Configuration to publish a Cloud Pub/Sub message.
- "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
- # `projects/<project>/topics/<topic>`. The project needs to be the same
- # project as this config is in.
- "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
+ "a_key": { # Configuration to publish a Cloud Pub/Sub message.
+ "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
# messages. This service account needs to be in the same project as the
# PubsubConfig. When added, the caller needs to have
# iam.serviceAccounts.actAs permission on this service account. If
# unspecified, it defaults to the compute engine default service account.
- "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
+ "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
+ # `projects/<project>/topics/<topic>`. The project needs to be the same
+ # project as this config is in.
},
},
- "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
+ "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
# returned by GetRepo.
- "name": "A String", # Resource name of the repository, of the form
+ "name": "A String", # Resource name of the repository, of the form
# `projects/<project>/repos/<repo>`. The repo name may contain slashes.
# eg, `projects/myproject/repos/name/with/slash`
- "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
- # Read-only field.
- # hosting service, for example GitHub or Bitbucket.
- "url": "A String", # URL of the main repository at the other hosting service.
- "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
- # Removing this webhook from the other hosting service will stop
- # Google Cloud Source Repositories from receiving notifications,
- # and thereby disabling mirroring.
- "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
- # Removing this key from the other service would deauthorize
- # Google Cloud Source Repositories from mirroring.
- },
}</pre>
</div>
@@ -771,7 +771,7 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "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.
@@ -792,28 +792,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "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.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')",
+ # "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
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -831,19 +831,135 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # 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/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "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.
+ "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.
+ "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.
+ "logType": "A String", # The log type that this config enables.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ },
+ ],
+ "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.
+ },
+ ],
+ "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`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "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
@@ -886,9 +1002,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ "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.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
@@ -897,167 +1015,49 @@
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # 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"
+ # 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'"
+ # 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)"
+ # 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.
- "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.
- "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
+ "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.
+ "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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
},
],
- "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.
- "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.
- },
- ],
- "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.
- },
- ],
- "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.
},
- "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+ "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"`
+ # `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
@@ -1086,28 +1086,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "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.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')",
+ # "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
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1125,19 +1125,135 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # 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/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "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.
+ "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.
+ "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.
+ "logType": "A String", # The log type that this config enables.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ },
+ ],
+ "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.
+ },
+ ],
+ "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`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "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
@@ -1180,9 +1296,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ "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.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
@@ -1191,161 +1309,43 @@
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # 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"
+ # 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'"
+ # 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)"
+ # 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.
- "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.
- "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
+ "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.
+ "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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
},
],
- "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.
- "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.
- },
- ],
- "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.
- },
- ],
- "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.
}</pre>
</div>
@@ -1374,34 +1374,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
+ "metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -1409,11 +1391,29 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
}</pre>
</div>
@@ -1430,11 +1430,11 @@
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
+ "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",
+ "A String",
],
}
@@ -1447,9 +1447,9 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
- "A String",
+ "A String",
],
}</pre>
</div>