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

blob: bb441cc2e4d5a74079579e60caf7bb010f8b833b [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="bigtableadmin_v2.projects.instances.appProfiles.html">appProfiles()</a></code>
				79	</p>
				80	<p class="firstline">Returns the appProfiles Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="bigtableadmin_v2.projects.instances.clusters.html">clusters()</a></code>
				84	</p>
				85	<p class="firstline">Returns the clusters Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="bigtableadmin_v2.projects.instances.tables.html">tables()</a></code>
				89	</p>
				90	<p class="firstline">Returns the tables Resource.</p>
				91
				92	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	93	<code><a href="#close">close()</a></code></p>
				94	<p class="firstline">Close httplib2 connections.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Create an instance within a project.</p>
				98	<p class="toc_element">
				99	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				100	<p class="firstline">Delete an instance from a project.</p>
				101	<p class="toc_element">
				102	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				103	<p class="firstline">Gets information about an instance.</p>
				104	<p class="toc_element">
				105	<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]	106	<p class="firstline">Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	107	<p class="toc_element">
				108	<code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p>
				109	<p class="firstline">Lists information about instances in a project.</p>
				110	<p class="toc_element">
				111	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				112	<p class="firstline">Retrieves the next page of results.</p>
				113	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	114	<code><a href="#partialUpdateInstance">partialUpdateInstance(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	115	<p class="firstline">Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	116	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	117	<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]	118	<p class="firstline">Sets the access control policy on an instance resource. Replaces any existing policy.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	119	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	120	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121	<p class="firstline">Returns permissions that the caller has on the specified instance resource.</p>
				122	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	123	<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	124	<p class="firstline">Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	125	<h3>Method Details</h3>
				126	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	127	<code class="details" id="close">close()</code>
				128	<pre>Close httplib2 connections.</pre>
				129	</div>
				130
				131	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	132	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	133	<pre>Create an instance within a project.
				134
				135	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	136	parent: string, Required. The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	137	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	138	The object takes the form of:
				139
				140	{ # Request message for BigtableInstanceAdmin.CreateInstance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	141	"clusters": { # Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most four clusters can be specified.
				142	"a_key": { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	143	"state": "A String", # Output only. The current state of the cluster.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	144	"location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	145	"serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
				146	"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
				147	"name": "A String", # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	148	},
				149	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	150	"parent": "A String", # Required. The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`.
				151	"instanceId": "A String", # Required. The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	152	"instance": { # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. # Required. The instance to create. Fields marked `OutputOnly` must be left blank.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	153	"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
				154	"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.
				155	"state": "A String", # Output only. The current state of the instance.
				156	"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
				157	"a_key": "A String",
				158	},
				159	"name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	160	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	161	}
				162
				163	x__xgafv: string, V1 error format.
				164	Allowed values
				165	1 - v1 error format
				166	2 - v2 error format
				167
				168	Returns:
				169	An object of the form:
				170
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	171	{ # This resource represents a long-running operation that is the result of a network API call.
				172	"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}`.
				173	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	174	"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`.
				175	"a_key": "", # Properties of the object. Contains field @type with type URL.
				176	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	177	"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.
				178	"a_key": "", # Properties of the object. Contains field @type with type URL.
				179	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	180	"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.
				181	"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]	182	{
				183	"a_key": "", # Properties of the object. Contains field @type with type URL.
				184	},
				185	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	186	"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.
				187	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	188	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	189	}</pre>
				190	</div>
				191
				192	<div class="method">
				193	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				194	<pre>Delete an instance from a project.
				195
				196	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	197	name: string, Required. The unique name of the instance to be deleted. Values are of the form `projects/{project}/instances/{instance}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	198	x__xgafv: string, V1 error format.
				199	Allowed values
				200	1 - v1 error format
				201	2 - v2 error format
				202
				203	Returns:
				204	An object of the form:
				205
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	206	{ # 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	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	207	}</pre>
				208	</div>
				209
				210	<div class="method">
				211	<code class="details" id="get">get(name, x__xgafv=None)</code>
				212	<pre>Gets information about an instance.
				213
				214	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	215	name: string, Required. The unique name of the requested instance. Values are of the form `projects/{project}/instances/{instance}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	216	x__xgafv: string, V1 error format.
				217	Allowed values
				218	1 - v1 error format
				219	2 - v2 error format
				220
				221	Returns:
				222	An object of the form:
				223
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	224	{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	225	"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
				226	"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.
				227	"state": "A String", # Output only. The current state of the instance.
				228	"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
				229	"a_key": "A String",
				230	},
				231	"name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
				232	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	233	</div>
				234
				235	<div class="method">
				236	<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]	237	<pre>Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	238
				239	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	240	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	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	241	body: object, The request body.
				242	The object takes the form of:
				243
				244	{ # Request message for `GetIamPolicy` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	245	"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
				246	"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).
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	247	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	248	}
				249
				250	x__xgafv: string, V1 error format.
				251	Allowed values
				252	1 - v1 error format
				253	2 - v2 error format
				254
				255	Returns:
				256	An object of the form:
				257
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	258	{ # 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	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	259	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	260	"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.
				261	{ # Associates `members` with a `role`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	262	"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).
				263	"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.
				264	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				265	"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.
				266	"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.
				267	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	268	"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`.
				269	"A String",
				270	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	271	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	272	},
				273	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	274	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	275	{ # 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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	276	"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]	277	"auditLogConfigs": [ # The configuration for logging of each type of permission.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	278	{ # 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^]	279	"logType": "A String", # The log type that this config enables.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	280	"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]	281	"A String",
				282	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	283	},
				284	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	285	},
				286	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	287	"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).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	288	}</pre>
				289	</div>
				290
				291	<div class="method">
				292	<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
				293	<pre>Lists information about instances in a project.
				294
				295	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	296	parent: string, Required. The unique name of the project for which a list of instances is requested. Values are of the form `projects/{project}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	297	pageToken: string, DEPRECATED: This field is unused and ignored.
				298	x__xgafv: string, V1 error format.
				299	Allowed values
				300	1 - v1 error format
				301	2 - v2 error format
				302
				303	Returns:
				304	An object of the form:
				305
				306	{ # Response message for BigtableInstanceAdmin.ListInstances.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	307	"instances": [ # The list of requested instances.
				308	{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
				309	"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
				310	"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.
				311	"state": "A String", # Output only. The current state of the instance.
				312	"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
				313	"a_key": "A String",
				314	},
				315	"name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
				316	},
				317	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	318	"failedLocations": [ # Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from `instances`, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form `projects//locations/`
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	319	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	320	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	321	"nextPageToken": "A String", # DEPRECATED: This field is unused and ignored.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	322	}</pre>
				323	</div>
				324
				325	<div class="method">
				326	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				327	<pre>Retrieves the next page of results.
				328
				329	Args:
				330	previous_request: The request for the previous page. (required)
				331	previous_response: The response from the request for the previous page. (required)
				332
				333	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	334	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	335	page. Returns None if there are no more items in the collection.
				336	</pre>
				337	</div>
				338
				339	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	340	<code class="details" id="partialUpdateInstance">partialUpdateInstance(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	341	<pre>Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	342
				343	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	344	name: string, The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	345	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	346	The object takes the form of:
				347
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	348	{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	349	"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
				350	"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.
				351	"state": "A String", # Output only. The current state of the instance.
				352	"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
				353	"a_key": "A String",
				354	},
				355	"name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
				356	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	357
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	358	updateMask: string, Required. The subset of Instance fields which should be replaced. Must be explicitly set.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	359	x__xgafv: string, V1 error format.
				360	Allowed values
				361	1 - v1 error format
				362	2 - v2 error format
				363
				364	Returns:
				365	An object of the form:
				366
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	367	{ # This resource represents a long-running operation that is the result of a network API call.
				368	"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}`.
				369	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	370	"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`.
				371	"a_key": "", # Properties of the object. Contains field @type with type URL.
				372	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	373	"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.
				374	"a_key": "", # Properties of the object. Contains field @type with type URL.
				375	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	376	"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.
				377	"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]	378	{
				379	"a_key": "", # Properties of the object. Contains field @type with type URL.
				380	},
				381	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	382	"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.
				383	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	384	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	385	}</pre>
				386	</div>
				387
				388	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	389	<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]	390	<pre>Sets the access control policy on an instance resource. Replaces any existing policy.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	391
				392	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	393	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]	394	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	395	The object takes the form of:
				396
				397	{ # Request message for `SetIamPolicy` method.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	398	"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"`
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	399	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	400	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	401	"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.
				402	{ # Associates `members` with a `role`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	403	"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).
				404	"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.
				405	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				406	"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.
				407	"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.
				408	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	409	"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`.
				410	"A String",
				411	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	412	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	413	},
				414	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	415	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	416	{ # 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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	417	"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]	418	"auditLogConfigs": [ # The configuration for logging of each type of permission.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	419	{ # 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^]	420	"logType": "A String", # The log type that this config enables.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	421	"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]	422	"A String",
				423	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	424	},
				425	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	426	},
				427	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	428	"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).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	429	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	430	}
				431
				432	x__xgafv: string, V1 error format.
				433	Allowed values
				434	1 - v1 error format
				435	2 - v2 error format
				436
				437	Returns:
				438	An object of the form:
				439
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	440	{ # 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	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	441	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	442	"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.
				443	{ # Associates `members` with a `role`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	444	"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).
				445	"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.
				446	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				447	"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.
				448	"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.
				449	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	450	"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`.
				451	"A String",
				452	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	453	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	454	},
				455	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	456	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	457	{ # 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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	458	"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]	459	"auditLogConfigs": [ # The configuration for logging of each type of permission.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	460	{ # 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^]	461	"logType": "A String", # The log type that this config enables.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	462	"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]	463	"A String",
				464	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	465	},
				466	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	467	},
				468	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	470	}</pre>
				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>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	475	<pre>Returns permissions that the caller has on the specified instance resource.
				476
				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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	480	The object takes the form of:
				481
				482	{ # Request message for `TestIamPermissions` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	484	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	485	],
				486	}
				487
				488	x__xgafv: string, V1 error format.
				489	Allowed values
				490	1 - v1 error format
				491	2 - v2 error format
				492
				493	Returns:
				494	An object of the form:
				495
				496	{ # Response message for `TestIamPermissions` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	497	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	498	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	499	],
				500	}</pre>
				501	</div>
				502
				503	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	504	<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	505	<pre>Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	506
				507	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	508	name: string, The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	509	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	510	The object takes the form of:
				511
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	512	{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	513	"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
				514	"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.
				515	"state": "A String", # Output only. The current state of the instance.
				516	"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
				517	"a_key": "A String",
				518	},
				519	"name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
				520	}
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	521
				522	x__xgafv: string, V1 error format.
				523	Allowed values
				524	1 - v1 error format
				525	2 - v2 error format
				526
				527	Returns:
				528	An object of the form:
				529
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	530	{ # A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	531	"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
				532	"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.
				533	"state": "A String", # Output only. The current state of the instance.
				534	"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
				535	"a_key": "A String",
				536	},
				537	"name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
				538	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	539	</div>
				540
				541	</body></html>