Google Git
Sign in
android / platform / external / python / google-api-python-client / refs/heads/android12L-d2-s5-release / . / docs / dyn / sourcerepo_v1.projects.repos.html
blob: 34a0474ea4a8ef3e709ee7f999c1ca5b28892ad6 [file] [log] [blame] [edit]
<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="sourcerepo_v1.html">Cloud Source Repositories API</a> . <a href="sourcerepo_v1.projects.html">projects</a> . <a href="sourcerepo_v1.projects.repos.html">repos</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a repo in the given project with the given name.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a repo.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about a repo.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, 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>
<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>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates information about a repo.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
<p class="toc_element">
<code><a href="#sync">sync(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Synchronize a connected repo.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body, x__xgafv=None)</code>
<pre>Creates a repo in the given project with the given name.
If the named repository already exists, `CreateRepo` returns
`ALREADY_EXISTS`.
Args:
parent: string, The project in which to create the repo. Values are of the form
`projects/<project>`. (required)
body: object, The request body. (required)
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.
# 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.
"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
"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.
},
},
"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
# `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.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
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.
# 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.
"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
"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.
},
},
"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
# `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>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a repo.
Args:
name: string, The name of the repo to delete. Values are of the form
`projects/<project>/repos/<repo>`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns information about a repo.
Args:
name: string, The name of the requested repository. Values are of the form
`projects/<project>/repos/<repo>`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
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.
# 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.
"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
"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.
},
},
"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
# `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>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
<pre>Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
set.
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
#
#
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
#
# **JSON Example**
#
# {
# "bindings": [
# {
# "role": "roles/owner",
# "members": [
# "user:[email protected]",
# "group:[email protected]",
# "domain:google.com",
# "serviceAccount:[email protected]"
# ]
# },
# {
# "role": "roles/viewer",
# "members": ["user:[email protected]"]
# }
# ]
# }
#
# **YAML Example**
#
# bindings:
# - members:
# - user:[email protected]
# - group:[email protected]
# - domain:google.com
# - serviceAccount:[email protected]
# role: roles/owner
# - members:
# - user:[email protected]
# role: roles/viewer
#
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam/docs).
"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:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "fooservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:[email protected]"
# ]
# }
# ]
# }
# ]
# }
#
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts [email protected] from DATA_READ logging, and
# [email protected] 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:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# [email protected] 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.
},
],
"version": 42, # Deprecated.
"bindings": [ # Associates a list of `members` to a `role`.
# `bindings` with no members will result in an error.
{ # 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` 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, `[email protected]` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `[email protected]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `[email protected]`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
"condition": { # Represents an expression text. Example: # 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.
#
# title: "User account presence"
# description: "Determines whether the request has a user account"
# expression: "size(request.user) > 0"
"location": "A String", # An optional string indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in
# Common Expression Language syntax.
#
# The application context of the containing message determines which
# well-known feature set of CEL is supported.
"description": "A String", # An optional description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # An 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.
},
},
],
"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.
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=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.
Args:
name: string, The project ID whose repos should be listed. Values are of the form
`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.
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.
{ # 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.
# 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.
"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
"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.
},
},
"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
# `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>
<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="patch">patch(name, body, x__xgafv=None)</code>
<pre>Updates information about a repo.
Args:
name: string, The name of the requested repository. Values are of the form
`projects/<project>/repos/<repo>`. (required)
body: object, The request body. (required)
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.
# 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.
"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
"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.
},
},
"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
# `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
# in the mask will be modified. If no mask is provided, this request is
# no-op.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
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.
# 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.
"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
"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.
},
},
"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
# `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>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified resource. Replaces any
existing policy.
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. (required)
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # 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.
# specify access control policies for Cloud Platform resources.
#
#
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
#
# **JSON Example**
#
# {
# "bindings": [
# {
# "role": "roles/owner",
# "members": [
# "user:[email protected]",
# "group:[email protected]",
# "domain:google.com",
# "serviceAccount:[email protected]"
# ]
# },
# {
# "role": "roles/viewer",
# "members": ["user:[email protected]"]
# }
# ]
# }
#
# **YAML Example**
#
# bindings:
# - members:
# - user:[email protected]
# - group:[email protected]
# - domain:google.com
# - serviceAccount:[email protected]
# role: roles/owner
# - members:
# - user:[email protected]
# role: roles/viewer
#
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam/docs).
"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:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "fooservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:[email protected]"
# ]
# }
# ]
# }
# ]
# }
#
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts [email protected] from DATA_READ logging, and
# [email protected] 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:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# [email protected] 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.
},
],
"version": 42, # Deprecated.
"bindings": [ # Associates a list of `members` to a `role`.
# `bindings` with no members will result in an error.
{ # 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` 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, `[email protected]` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `[email protected]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `[email protected]`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
"condition": { # Represents an expression text. Example: # 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.
#
# title: "User account presence"
# description: "Determines whether the request has a user account"
# expression: "size(request.user) > 0"
"location": "A String", # An optional string indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in
# Common Expression Language syntax.
#
# The application context of the containing message determines which
# well-known feature set of CEL is supported.
"description": "A String", # An optional description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # An 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.
},
},
],
"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.
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
},
"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"
# This field is only used by Cloud IAM.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
#
#
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
#
# **JSON Example**
#
# {
# "bindings": [
# {
# "role": "roles/owner",
# "members": [
# "user:[email protected]",
# "group:[email protected]",
# "domain:google.com",
# "serviceAccount:[email protected]"
# ]
# },
# {
# "role": "roles/viewer",
# "members": ["user:[email protected]"]
# }
# ]
# }
#
# **YAML Example**
#
# bindings:
# - members:
# - user:[email protected]
# - group:[email protected]
# - domain:google.com
# - serviceAccount:[email protected]
# role: roles/owner
# - members:
# - user:[email protected]
# role: roles/viewer
#
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam/docs).
"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:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "fooservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:[email protected]"
# ]
# }
# ]
# }
# ]
# }
#
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts [email protected] from DATA_READ logging, and
# [email protected] 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:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# [email protected] 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.
},
],
"version": 42, # Deprecated.
"bindings": [ # Associates a list of `members` to a `role`.
# `bindings` with no members will result in an error.
{ # 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` 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, `[email protected]` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `[email protected]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `[email protected]`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
"condition": { # Represents an expression text. Example: # 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.
#
# title: "User account presence"
# description: "Determines whether the request has a user account"
# expression: "size(request.user) > 0"
"location": "A String", # An optional string indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in
# Common Expression Language syntax.
#
# The application context of the containing message determines which
# well-known feature set of CEL is supported.
"description": "A String", # An optional description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # An 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.
},
},
],
"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.
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
}</pre>
</div>
<div class="method">
<code class="details" id="sync">sync(name, body=None, x__xgafv=None)</code>
<pre>Synchronize a connected repo.
The response contains SyncRepoMetadata in the metadata field.
Args:
name: string, The name of the repo to synchronize. Values are of the form
`projects/<project>/repos/<repo>`. (required)
body: object, The request body.
The object takes the form of:
{ # Request for SyncRepo.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a
# network API call.
"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
# methods, the response should have the type `XxxResponse`, where `Xxx`
# 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.
},
"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.
},
"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.
"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 have the format of `operations/some/unique/name`.
"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). The error model is designed to be:
#
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
#
# # Overview
#
# The `Status` message contains three pieces of data: error code, error
# message, and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` that can be used for common error conditions.
#
# # Language mapping
#
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
#
# # Other uses
#
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
#
# Example uses of this error model include:
#
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
#
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting.
#
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
#
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
#
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
"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.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
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. (required)
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>
</body></html>