Blame - docs/dyn/pubsub_v1.projects.topics.html - platform/external/python/google-api-python-client

blob: c7f51b1cf935bdf99d02ea29c2016d8623dfd33b [file] [log] [blame]

Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	75	<h1><a href="pubsub_v1.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a> . <a href="pubsub_v1.projects.topics.html">topics</a></h1>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	78	<code><a href="pubsub_v1.projects.topics.snapshots.html">snapshots()</a></code>
				79	</p>
				80	<p class="firstline">Returns the snapshots Resource.</p>
				81
				82	<p class="toc_element">
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	83	<code><a href="pubsub_v1.projects.topics.subscriptions.html">subscriptions()</a></code>
				84	</p>
				85	<p class="firstline">Returns the subscriptions Resource.</p>
				86
				87	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<code><a href="#close">close()</a></code></p>
				89	<p class="firstline">Close httplib2 connections.</p>
				90	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	91	<code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	92	<p class="firstline">Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names).</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	93	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	94	<code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	95	<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>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	96	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	97	<code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	98	<p class="firstline">Gets the configuration of a topic.</p>
				99	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	100	<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	101	<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>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	102	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	103	<code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	104	<p class="firstline">Lists matching topics.</p>
				105	<p class="toc_element">
				106	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				107	<p class="firstline">Retrieves the next page of results.</p>
				108	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	109	<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	110	<p class="firstline">Updates an existing topic. Note that certain properties of a topic are not modifiable.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	112	<code><a href="#publish">publish(topic, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	113	<p class="firstline">Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	114	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	115	<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	116	<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	117	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	118	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	119	<p class="firstline">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. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	120	<h3>Method Details</h3>
				121	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	122	<code class="details" id="close">close()</code>
				123	<pre>Close httplib2 connections.</pre>
				124	</div>
				125
				126	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	127	<code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	128	<pre>Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	129
				130	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	131	name: string, Required. 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)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	132	body: object, The request body.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	133	The object takes the form of:
				134
				135	{ # A topic resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	136	"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects//locations//keyRings//cryptoKeys/`.
				137	"labels": { # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
				138	"a_key": "A String",
				139	},
				140	"messageStoragePolicy": { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
				141	"allowedPersistenceRegions": [ # A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
				142	"A String",
				143	],
				144	},
				145	"name": "A String", # Required. 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"`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	146	"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
				147	"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
				148	"encoding": "A String", # The encoding of messages validated against `schema`.
				149	"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
				150	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	151	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	152
				153	x__xgafv: string, V1 error format.
				154	Allowed values
				155	1 - v1 error format
				156	2 - v2 error format
				157
				158	Returns:
				159	An object of the form:
				160
				161	{ # A topic resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	162	"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects//locations//keyRings//cryptoKeys/`.
				163	"labels": { # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
				164	"a_key": "A String",
				165	},
				166	"messageStoragePolicy": { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
				167	"allowedPersistenceRegions": [ # A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
				168	"A String",
				169	],
				170	},
				171	"name": "A String", # Required. 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"`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	172	"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
				173	"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
				174	"encoding": "A String", # The encoding of messages validated against `schema`.
				175	"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
				176	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	177	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	178	</div>
				179
				180	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	181	<code class="details" id="delete">delete(topic, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	182	<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_`.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	183
				184	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	185	topic: string, Required. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	186	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	187	Allowed values
				188	1 - v1 error format
				189	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	190
				191	Returns:
				192	An object of the form:
				193
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	194	{ # 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 `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	195	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	196	</div>
				197
				198	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	199	<code class="details" id="get">get(topic, x__xgafv=None)</code>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	200	<pre>Gets the configuration of a topic.
				201
				202	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	203	topic: string, Required. The name of the topic to get. Format is `projects/{project}/topics/{topic}`. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	204	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	205	Allowed values
				206	1 - v1 error format
				207	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	208
				209	Returns:
				210	An object of the form:
				211
				212	{ # A topic resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	213	"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects//locations//keyRings//cryptoKeys/`.
				214	"labels": { # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
				215	"a_key": "A String",
				216	},
				217	"messageStoragePolicy": { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
				218	"allowedPersistenceRegions": [ # A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
				219	"A String",
				220	],
				221	},
				222	"name": "A String", # Required. 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"`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	223	"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
				224	"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
				225	"encoding": "A String", # The encoding of messages validated against `schema`.
				226	"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
				227	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	228	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	229	</div>
				230
				231	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	232	<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	233	<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	234
				235	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	236	resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
				237	options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	238	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	239	Allowed values
				240	1 - v1 error format
				241	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	242
				243	Returns:
				244	An object of the form:
				245
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	246	{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	247	"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.
				248	{ # Associates `members` with a `role`.
				249	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				250	"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.
				251	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				252	"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.
				253	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	254	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	255	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
				256	"A String",
				257	],
				258	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				259	},
				260	],
				261	"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.
				262	"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				263	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	264	</div>
				265
				266	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	267	<code class="details" id="list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	268	<pre>Lists matching topics.
				269
				270	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	271	project: string, Required. The name of the project in which to list topics. Format is `projects/{project-id}`. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	272	pageSize: integer, Maximum number of topics to return.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	273	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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	274	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	275	Allowed values
				276	1 - v1 error format
				277	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	278
				279	Returns:
				280	An object of the form:
				281
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	282	{ # Response for the `ListTopics` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	283	"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`.
				284	"topics": [ # The resulting topics.
				285	{ # A topic resource.
				286	"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects//locations//keyRings//cryptoKeys/`.
				287	"labels": { # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
				288	"a_key": "A String",
				289	},
				290	"messageStoragePolicy": { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
				291	"allowedPersistenceRegions": [ # A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
				292	"A String",
				293	],
				294	},
				295	"name": "A String", # Required. 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"`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	296	"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
				297	"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
				298	"encoding": "A String", # The encoding of messages validated against `schema`.
				299	"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
				300	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	301	},
				302	],
				303	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	304	</div>
				305
				306	<div class="method">
				307	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				308	<pre>Retrieves the next page of results.
				309
				310	Args:
				311	previous_request: The request for the previous page. (required)
				312	previous_response: The response from the request for the previous page. (required)
				313
				314	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	315	A request object that you can call 'execute()' on to request the next
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	316	page. Returns None if there are no more items in the collection.
				317	</pre>
				318	</div>
				319
				320	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	321	<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	322	<pre>Updates an existing topic. Note that certain properties of a topic are not modifiable.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	323
				324	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	325	name: string, Required. 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)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	326	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	327	The object takes the form of:
				328
				329	{ # Request for the UpdateTopic method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	330	"topic": { # A topic resource. # Required. The updated topic object.
				331	"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects//locations//keyRings//cryptoKeys/`.
				332	"labels": { # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
				333	"a_key": "A String",
				334	},
				335	"messageStoragePolicy": { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
				336	"allowedPersistenceRegions": [ # A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
				337	"A String",
				338	],
				339	},
				340	"name": "A String", # Required. 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"`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	341	"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
				342	"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
				343	"encoding": "A String", # The encoding of messages validated against `schema`.
				344	"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
				345	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	346	},
				347	"updateMask": "A String", # Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" but the `message_storage_policy` is not set in the `topic` provided above, then the updated value is determined by the policy configured at the project or organization level.
				348	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	349
				350	x__xgafv: string, V1 error format.
				351	Allowed values
				352	1 - v1 error format
				353	2 - v2 error format
				354
				355	Returns:
				356	An object of the form:
				357
				358	{ # A topic resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	359	"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects//locations//keyRings//cryptoKeys/`.
				360	"labels": { # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
				361	"a_key": "A String",
				362	},
				363	"messageStoragePolicy": { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
				364	"allowedPersistenceRegions": [ # A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
				365	"A String",
				366	],
				367	},
				368	"name": "A String", # Required. 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"`.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	369	"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
				370	"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
				371	"encoding": "A String", # The encoding of messages validated against `schema`.
				372	"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
				373	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	374	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	375	</div>
				376
				377	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	378	<code class="details" id="publish">publish(topic, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	379	<pre>Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	380
				381	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	382	topic: string, Required. The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	383	body: object, The request body.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	384	The object takes the form of:
				385
				386	{ # Request for the Publish method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	387	"messages": [ # Required. The messages to publish.
				388	{ # A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding [client library documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.
				389	"attributes": { # Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
				390	"a_key": "A String",
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	391	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	392	"data": "A String", # The message data field. If this field is empty, the message must contain at least one attribute.
				393	"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.
				394	"orderingKey": "A String", # If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value.
				395	"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.
				396	},
				397	],
				398	}
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	399
				400	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	401	Allowed values
				402	1 - v1 error format
				403	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	404
				405	Returns:
				406	An object of the form:
				407
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	408	{ # Response for the `Publish` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	409	"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.
				410	"A String",
				411	],
				412	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	413	</div>
				414
				415	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	416	<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	417	<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	418
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	419	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	420	resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	421	body: object, The request body.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	422	The object takes the form of:
				423
				424	{ # Request message for `SetIamPolicy` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	425	"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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.
				426	"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.
				427	{ # Associates `members` with a `role`.
				428	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				429	"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.
				430	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				431	"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.
				432	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	433	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	434	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
				435	"A String",
				436	],
				437	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				438	},
				439	],
				440	"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.
				441	"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				442	},
				443	}
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	444
				445	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	446	Allowed values
				447	1 - v1 error format
				448	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	449
				450	Returns:
				451	An object of the form:
				452
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	453	{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	454	"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.
				455	{ # Associates `members` with a `role`.
				456	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				457	"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.
				458	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				459	"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.
				460	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	461	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	462	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
				463	"A String",
				464	],
				465	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				466	},
				467	],
				468	"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.
				469	"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				470	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	471	</div>
				472
				473	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	474	<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	475	<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. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	476
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	477	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	478	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)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	479	body: object, The request body.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	480	The object takes the form of:
				481
				482	{ # Request message for `TestIamPermissions` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	483	"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).
				484	"A String",
				485	],
				486	}
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	487
				488	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	489	Allowed values
				490	1 - v1 error format
				491	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	492
				493	Returns:
				494	An object of the form:
				495
				496	{ # Response message for `TestIamPermissions` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	497	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				498	"A String",
				499	],
				500	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	501	</div>
				502
				503	</body></html>