Release v1.6.0 (#324)
* Update version and changelog for v1.6.0
* Update docs
diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html
index 0d960fa..026d91b 100644
--- a/docs/dyn/pubsub_v1.projects.topics.html
+++ b/docs/dyn/pubsub_v1.projects.topics.html
@@ -80,130 +80,256 @@
<p class="firstline">Returns the subscriptions Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(name=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates the given topic with the given name.</p>
<p class="toc_element">
- <code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.</p>
+ <code><a href="#delete">delete(topic=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes the topic with the given name. Returns `NOT_FOUND` if the topic</p>
<p class="toc_element">
- <code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(topic=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration of a topic.</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. Returns an empty policy if the resource exists and does not have a policy set.</p>
+ <code><a href="#getIamPolicy">getIamPolicy(resource=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(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(project=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching topics.</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="#publish">publish(topic, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.</p>
+ <code><a href="#publish">publish(topic=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic</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 existing policy.</p>
+ <code><a href="#setIamPolicy">setIamPolicy(resource=None, 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="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
+ <code><a href="#testIamPermissions">testIamPermissions(resource=None, 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(name, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(name=None, body, x__xgafv=None)</code>
<pre>Creates the given topic with the given name.
Args:
- name: string, The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
+ name: string, The name of the topic. It must have the format
+`"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
+and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+signs (`%`). It must be between 3 and 255 characters in length, and it
+must not start with `"goog"`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A topic resource.
- "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
+ "name": "A String", # The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
+ # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+ # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+ # signs (`%`). It must be between 3 and 255 characters in length, and it
+ # must not start with `"goog"`.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # A topic resource.
- "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
+ "name": "A String", # The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
+ # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+ # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+ # signs (`%`). It must be between 3 and 255 characters in length, and it
+ # must not start with `"goog"`.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(topic, x__xgafv=None)</code>
- <pre>Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.
+ <code class="details" id="delete">delete(topic=None, x__xgafv=None)</code>
+ <pre>Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
+does not exist. After a topic is deleted, a new topic may be created with
+the same name; this is an entirely new topic with none of the old
+configuration or subscriptions. Existing subscriptions to this topic are
+not deleted, but their `topic` field is set to `_deleted-topic_`.
Args:
- topic: string, Name of the topic to delete. (required)
+ topic: string, Name of the topic to delete.
+Format is `projects/{project}/topics/{topic}`. (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 `{}`.
+ { # 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(topic, x__xgafv=None)</code>
+ <code class="details" id="get">get(topic=None, x__xgafv=None)</code>
<pre>Gets the configuration of a topic.
Args:
- topic: string, The name of the topic to get. (required)
+ topic: string, The name of the topic to get.
+Format is `projects/{project}/topics/{topic}`. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # A topic resource.
- "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
+ "name": "A String", # The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
+ # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+ # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+ # signs (`%`). It must be between 3 and 255 characters in length, and it
+ # must not start with `"goog"`.
}</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.
+ <code class="details" id="getIamPolicy">getIamPolicy(resource=None, 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. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested.
+`resource` is usually specified as a path. For example, a Project
+resource is specified as `projects/{project}`. (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. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
- "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # 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.
+ #
+ # **Example**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/owner",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # ]
+ # },
+ # {
+ # "role": "roles/viewer",
+ # "members": ["user:sean@example.com"]
+ # }
+ # ]
+ # }
+ #
+ # For a description of IAM and its features, see the
+ # [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`.
+ # Multiple `bindings` must not be specified for the same `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`. Required
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ # Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
"A String",
],
},
],
+ "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.
"version": 42, # Version of the `Policy`. The default version is 0.
- "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(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(project=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists matching topics.
Args:
- project: string, The name of the cloud project that topics belong to. (required)
+ project: string, The name of the cloud project that topics belong to.
+Format is `projects/{project}`. (required)
pageSize: integer, Maximum number of topics to return.
- pageToken: string, The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.
+ pageToken: string, The value returned by the last `ListTopicsResponse`; indicates that this is
+a continuation of a prior `ListTopics` call, and that the system should
+return the next page of data.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Response for the `ListTopics` method.
- "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.
+ "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the
+ # request; this value should be passed in a new `ListTopicsRequest`.
"topics": [ # The resulting topics.
{ # A topic resource.
- "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
+ "name": "A String", # The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
+ # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+ # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+ # signs (`%`). It must be between 3 and 255 characters in length, and it
+ # must not start with `"goog"`.
},
],
}</pre>
@@ -224,104 +350,266 @@
</div>
<div class="method">
- <code class="details" id="publish">publish(topic, body, x__xgafv=None)</code>
- <pre>Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
+ <code class="details" id="publish">publish(topic=None, body, x__xgafv=None)</code>
+ <pre>Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
+does not exist. The message payload must not be empty; it must contain
+ either a non-empty data field, or at least one attribute.
Args:
- topic: string, The messages in the request will be published on this topic. (required)
+ topic: string, The messages in the request will be published on this topic.
+Format is `projects/{project}/topics/{topic}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request for the Publish method.
"messages": [ # The messages to publish.
- { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
+ { # A message data and its attributes. The message payload must not be empty;
+ # it must contain either a non-empty data field, or at least one attribute.
"attributes": { # Optional attributes for this message.
"a_key": "A String",
},
- "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
- "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
- "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
+ "data": "A String", # The message payload.
+ "publishTime": "A String", # The time at which the message was published, populated by the server when
+ # it receives the `Publish` call. It must not be populated by the
+ # publisher in a `Publish` call.
+ "messageId": "A String", # ID of this message, assigned by the server when the message is published.
+ # Guaranteed to be unique within the topic. This value may be read by a
+ # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
+ # delivery. It must not be populated by the publisher in a `Publish` call.
},
],
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Response for the `Publish` method.
- "messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
+ "messageIds": [ # The server-assigned ID of each published message, in the same order as
+ # the messages in the request. IDs are guaranteed to be unique within
+ # the topic.
"A String",
],
}</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.
+ <code class="details" id="setIamPolicy">setIamPolicy(resource=None, 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. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified.
+`resource` is usually specified as a path. For example, a Project
+resource is specified as `projects/{project}`. (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 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. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # 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.
- "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ "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.
+ #
+ # **Example**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/owner",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # ]
+ # },
+ # {
+ # "role": "roles/viewer",
+ # "members": ["user:sean@example.com"]
+ # }
+ # ]
+ # }
+ #
+ # For a description of IAM and its features, see the
+ # [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`.
+ # Multiple `bindings` must not be specified for the same `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`. Required
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ # Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
"A String",
],
},
],
+ "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.
"version": 42, # Version of the `Policy`. The default version is 0.
- "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.
},
}
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. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
- "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # 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.
+ #
+ # **Example**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/owner",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # ]
+ # },
+ # {
+ # "role": "roles/viewer",
+ # "members": ["user:sean@example.com"]
+ # }
+ # ]
+ # }
+ #
+ # For a description of IAM and its features, see the
+ # [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`.
+ # Multiple `bindings` must not be specified for the same `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`. Required
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ # Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
"A String",
],
},
],
+ "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.
"version": 42, # Version of the `Policy`. The default version is 0.
- "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="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
+ <code class="details" id="testIamPermissions">testIamPermissions(resource=None, 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. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested.
+`resource` is usually specified as a path. For example, a Project
+resource is specified as `projects/{project}`. (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).
+ "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.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ # allowed.
"A String",
],
}</pre>