Blame - docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html - platform/external/python/google-api-python-client

blob: 01218c5d72df0ce7c968fa8d55c11bf531ce8c57 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -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
				75	<h1><a href="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.clusters.html">clusters</a> . <a href="bigtableadmin_v2.projects.instances.clusters.backups.html">backups</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	81	<code><a href="#create">create(parent, body=None, backupId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	82	<p class="firstline">Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.</p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a pending or completed Cloud Bigtable backup.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets metadata on a pending or completed Cloud Bigtable Backup.</p>
				89	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	90	<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	92	<p class="toc_element">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	93	<code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, orderBy=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<p class="firstline">Lists Cloud Bigtable backups. Returns both completed and pending backups.</p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	95	<p class="toc_element">
				96	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				97	<p class="firstline">Retrieves the next page of results.</p>
				98	<p class="toc_element">
				99	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				100	<p class="firstline">Updates a pending or completed Cloud Bigtable Backup.</p>
				101	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	102	<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]	103	<p class="firstline">Sets the access control policy on a Table resource. Replaces any existing policy.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	104	<p class="toc_element">
				105	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
				106	<p class="firstline">Returns permissions that the caller has on the specified table resource.</p>
				107	<h3>Method Details</h3>
				108	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	<code class="details" id="close">close()</code>
				110	<pre>Close httplib2 connections.</pre>
				111	</div>
				112
				113	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	114	<code class="details" id="create">create(parent, body=None, backupId=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	115	<pre>Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	116
				117	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	118	parent: string, Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	119	body: object, The request body.
				120	The object takes the form of:
				121
				122	{ # A backup of a Cloud Bigtable table.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	123	"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	124	"sourceTable": "A String", # Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	125	"sizeBytes": "A String", # Output only. Size of the backup in bytes.
				126	"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
				127	"state": "A String", # Output only. The current state of the backup.
				128	"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
				129	"endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	130	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	131
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	132	backupId: string, Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	133	x__xgafv: string, V1 error format.
				134	Allowed values
				135	1 - v1 error format
				136	2 - v2 error format
				137
				138	Returns:
				139	An object of the form:
				140
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	141	{ # This resource represents a long-running operation that is the result of a network API call.
				142	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	143	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				144	"a_key": "", # Properties of the object. Contains field @type with type URL.
				145	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	146	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	147	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	148	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				149	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	150	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	151	{
				152	"a_key": "", # Properties of the object. Contains field @type with type URL.
				153	},
				154	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	155	},
				156	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				157	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	158	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	159	}</pre>
				160	</div>
				161
				162	<div class="method">
				163	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				164	<pre>Deletes a pending or completed Cloud Bigtable backup.
				165
				166	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	167	name: string, Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	168	x__xgafv: string, V1 error format.
				169	Allowed values
				170	1 - v1 error format
				171	2 - v2 error format
				172
				173	Returns:
				174	An object of the form:
				175
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	176	{ # 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 `{}`.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	177	}</pre>
				178	</div>
				179
				180	<div class="method">
				181	<code class="details" id="get">get(name, x__xgafv=None)</code>
				182	<pre>Gets metadata on a pending or completed Cloud Bigtable Backup.
				183
				184	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	185	name: string, Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	186	x__xgafv: string, V1 error format.
				187	Allowed values
				188	1 - v1 error format
				189	2 - v2 error format
				190
				191	Returns:
				192	An object of the form:
				193
				194	{ # A backup of a Cloud Bigtable table.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	195	"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	196	"sourceTable": "A String", # Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	197	"sizeBytes": "A String", # Output only. Size of the backup in bytes.
				198	"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
				199	"state": "A String", # Output only. The current state of the backup.
				200	"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
				201	"endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	202	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	203	</div>
				204
				205	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	206	<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	207	<pre>Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	208
				209	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	210	resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	211	body: object, The request body.
				212	The object takes the form of:
				213
				214	{ # Request message for `GetIamPolicy` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	215	"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
				216	"requestedPolicyVersion": 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	217	},
				218	}
				219
				220	x__xgafv: string, V1 error format.
				221	Allowed values
				222	1 - v1 error format
				223	2 - v2 error format
				224
				225	Returns:
				226	An object of the form:
				227
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	228	{ # 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/).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	229	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	230	{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	231	"auditLogConfigs": [ # The configuration for logging of each type of permission.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	232	{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	233	"logType": "A String", # The log type that this config enables.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	234	"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	235	"A String",
				236	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	237	},
				238	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	239	"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	240	},
				241	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	242	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	243	"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).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	244	"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.
				245	{ # Associates `members` with a `role`.
				246	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				247	"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`.
				248	"A String",
				249	],
				250	"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).
				251	"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.
				252	"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.
				253	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				254	"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.
				255	},
				256	},
				257	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	258	}</pre>
				259	</div>
				260
				261	<div class="method">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	262	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, orderBy=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	263	<pre>Lists Cloud Bigtable backups. Returns both completed and pending backups.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	264
				265	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	266	parent: string, Required. The cluster to list backups from. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. Use `{cluster} = '-'` to list backups for all clusters in an instance, e.g., `projects/{project}/instances/{instance}/clusters/-`. (required)
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	267	pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`.
				268	pageSize: integer, Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	269	filter: string, A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `source_table` * `state` * `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. Some examples of using filters are: * `name:"exact"` --> The backup's name is the string "exact". * `name:howl` --> The backup's name contains the string "howl". * `source_table:prod` --> The source_table's name contains the string "prod". * `state:CREATING` --> The backup is pending creation. * `state:READY` --> The backup is fully created and ready for use. * `(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")` --> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` --> The backup's size is greater than 10GB
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	270	orderBy: string, An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: * name * source_table * expire_time * start_time * end_time * size_bytes * state For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant. If order_by is empty, results will be sorted by `start_time` in descending order starting from the most recently created backup.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	271	x__xgafv: string, V1 error format.
				272	Allowed values
				273	1 - v1 error format
				274	2 - v2 error format
				275
				276	Returns:
				277	An object of the form:
				278
				279	{ # The response for ListBackups.
				280	"backups": [ # The list of matching backups.
				281	{ # A backup of a Cloud Bigtable table.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	282	"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	283	"sourceTable": "A String", # Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	284	"sizeBytes": "A String", # Output only. Size of the backup in bytes.
				285	"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
				286	"state": "A String", # Output only. The current state of the backup.
				287	"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
				288	"endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	289	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	290	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	291	"nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListBackups call to fetch more of the matching backups.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	292	}</pre>
				293	</div>
				294
				295	<div class="method">
				296	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				297	<pre>Retrieves the next page of results.
				298
				299	Args:
				300	previous_request: The request for the previous page. (required)
				301	previous_response: The response from the request for the previous page. (required)
				302
				303	Returns:
				304	A request object that you can call 'execute()' on to request the next
				305	page. Returns None if there are no more items in the collection.
				306	</pre>
				307	</div>
				308
				309	<div class="method">
				310	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				311	<pre>Updates a pending or completed Cloud Bigtable Backup.
				312
				313	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	314	name: string, A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	315	body: object, The request body.
				316	The object takes the form of:
				317
				318	{ # A backup of a Cloud Bigtable table.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	319	"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	320	"sourceTable": "A String", # Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	321	"sizeBytes": "A String", # Output only. Size of the backup in bytes.
				322	"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
				323	"state": "A String", # Output only. The current state of the backup.
				324	"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
				325	"endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	326	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	327
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	328	updateMask: string, Required. A mask specifying which fields (e.g. `expire_time`) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	329	x__xgafv: string, V1 error format.
				330	Allowed values
				331	1 - v1 error format
				332	2 - v2 error format
				333
				334	Returns:
				335	An object of the form:
				336
				337	{ # A backup of a Cloud Bigtable table.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	338	"startTime": "A String", # Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	339	"sourceTable": "A String", # Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	340	"sizeBytes": "A String", # Output only. Size of the backup in bytes.
				341	"expireTime": "A String", # Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
				342	"state": "A String", # Output only. The current state of the backup.
				343	"name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
				344	"endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	345	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	346	</div>
				347
				348	<div class="method">
				349	<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]	350	<pre>Sets the access control policy on a Table resource. Replaces any existing policy.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	351
				352	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	353	resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	354	body: object, The request body.
				355	The object takes the form of:
				356
				357	{ # Request message for `SetIamPolicy` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	358	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	359	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	360	{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	361	"auditLogConfigs": [ # The configuration for logging of each type of permission.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	362	{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	363	"logType": "A String", # The log type that this config enables.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	364	"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	365	"A String",
				366	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	367	},
				368	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	369	"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	370	},
				371	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	372	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	373	"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).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	374	"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.
				375	{ # Associates `members` with a `role`.
				376	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				377	"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`.
				378	"A String",
				379	],
				380	"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).
				381	"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.
				382	"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.
				383	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				384	"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.
				385	},
				386	},
				387	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	388	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	389	"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	390	}
				391
				392	x__xgafv: string, V1 error format.
				393	Allowed values
				394	1 - v1 error format
				395	2 - v2 error format
				396
				397	Returns:
				398	An object of the form:
				399
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	400	{ # 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/).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	401	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	402	{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	403	"auditLogConfigs": [ # The configuration for logging of each type of permission.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	404	{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	405	"logType": "A String", # The log type that this config enables.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	406	"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	407	"A String",
				408	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	409	},
				410	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	411	"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	412	},
				413	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	414	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	415	"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).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	416	"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.
				417	{ # Associates `members` with a `role`.
				418	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				419	"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`.
				420	"A String",
				421	],
				422	"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).
				423	"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.
				424	"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.
				425	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				426	"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.
				427	},
				428	},
				429	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	430	}</pre>
				431	</div>
				432
				433	<div class="method">
				434	<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
				435	<pre>Returns permissions that the caller has on the specified table resource.
				436
				437	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	438	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)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	439	body: object, The request body.
				440	The object takes the form of:
				441
				442	{ # Request message for `TestIamPermissions` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	443	"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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	444	"A String",
				445	],
				446	}
				447
				448	x__xgafv: string, V1 error format.
				449	Allowed values
				450	1 - v1 error format
				451	2 - v2 error format
				452
				453	Returns:
				454	An object of the form:
				455
				456	{ # Response message for `TestIamPermissions` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	457	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	458	"A String",
				459	],
				460	}</pre>
				461	</div>
				462
				463	</body></html>