Blame - docs/dyn/accesscontextmanager_v1.accessPolicies.html - platform/external/python/google-api-python-client

blob: 2039e560c0bf5b27d5c2e337fce47f5038c15d00 [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="accesscontextmanager_v1.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1.accessPolicies.html">accessPolicies</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="accesscontextmanager_v1.accessPolicies.accessLevels.html">accessLevels()</a></code>
				79	</p>
				80	<p class="firstline">Returns the accessLevels Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="accesscontextmanager_v1.accessPolicies.servicePerimeters.html">servicePerimeters()</a></code>
				84	</p>
				85	<p class="firstline">Returns the servicePerimeters Resource.</p>
				86
				87	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	88	<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	89	<p class="firstline">Create an `AccessPolicy`. Fails if this organization already has a</p>
				90	<p class="toc_element">
				91	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				92	<p class="firstline">Delete an AccessPolicy by resource</p>
				93	<p class="toc_element">
				94	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				95	<p class="firstline">Get an AccessPolicy by name.</p>
				96	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	97	<code><a href="#list">list(pageToken=None, pageSize=None, parent=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98	<p class="firstline">List all AccessPolicies under a</p>
				99	<p class="toc_element">
				100	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				101	<p class="firstline">Retrieves the next page of results.</p>
				102	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	103	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	104	<p class="firstline">Update an AccessPolicy. The</p>
				105	<h3>Method Details</h3>
				106	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	107	<code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	108	<pre>Create an `AccessPolicy`. Fails if this organization already has a
				109	`AccessPolicy`. The longrunning Operation will have a successful status
				110	once the `AccessPolicy` has propagated to long-lasting storage.
				111	Syntactic and basic semantic errors will be returned in `metadata` as a
				112	BadRequest proto.
				113
				114	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	115	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	116	The object takes the form of:
				117
				118	{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119	# attributes to use Google Cloud services) and `ServicePerimeters` (which
				120	# define regions of services able to freely pass data within a perimeter). An
				121	# access policy is globally visible within an organization, and the
				122	# restrictions it specifies apply to all projects within an organization.
				123	"name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
				124	# `accessPolicies/{policy_id}`
				125	"etag": "A String", # Output only. An opaque identifier for the current version of the
				126	# `AccessPolicy`. This will always be a strongly validated etag, meaning that
				127	# two Access Polices will be identical if and only if their etags are
				128	# identical. Clients should not expect this to be in any specific format.
				129	"parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
				130	# Hierarchy. Currently immutable once created. Format:
				131	# `organizations/{organization_id}`
				132	"title": "A String", # Required. Human readable title. Does not affect behavior.
				133	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	134
				135	x__xgafv: string, V1 error format.
				136	Allowed values
				137	1 - v1 error format
				138	2 - v2 error format
				139
				140	Returns:
				141	An object of the form:
				142
				143	{ # This resource represents a long-running operation that is the result of a
				144	# network API call.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	145	"name": "A String", # The server-assigned name, which is only unique within the same service that
				146	# originally returns it. If you use the default HTTP mapping, the
				147	# `name` should be a resource name ending with `operations/{unique_id}`.
				148	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				149	# different programming environments, including REST APIs and RPC APIs. It is
				150	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				151	# three pieces of data: error code, error message, and error details.
				152	#
				153	# You can find out more about this error model and how to work with it in the
				154	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				155	"message": "A String", # A developer-facing error message, which should be in English. Any
				156	# user-facing error message should be localized and sent in the
				157	# google.rpc.Status.details field, or localized by the client.
				158	"details": [ # A list of messages that carry the error details. There is a common set of
				159	# message types for APIs to use.
				160	{
				161	"a_key": "", # Properties of the object. Contains field @type with type URL.
				162	},
				163	],
				164	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				165	},
				166	"metadata": { # Service-specific metadata associated with the operation. It typically
				167	# contains progress information and common metadata such as create time.
				168	# Some services might not provide such metadata. Any method that returns a
				169	# long-running operation should document the metadata type, if any.
				170	"a_key": "", # Properties of the object. Contains field @type with type URL.
				171	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	"done": True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	173	# If `true`, the operation is completed, and either `error` or `response` is
				174	# available.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	175	"response": { # The normal response of the operation in case of success. If the original
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	176	# method returns no data on success, such as `Delete`, the response is
				177	# `google.protobuf.Empty`. If the original method is standard
				178	# `Get`/`Create`/`Update`, the response should be the resource. For other
				179	# methods, the response should have the type `XxxResponse`, where `Xxx`
				180	# is the original method name. For example, if the original method name
				181	# is `TakeSnapshot()`, the inferred response type is
				182	# `TakeSnapshotResponse`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	183	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	184	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	185	}</pre>
				186	</div>
				187
				188	<div class="method">
				189	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				190	<pre>Delete an AccessPolicy by resource
				191	name. The longrunning Operation will have a successful status once the
				192	AccessPolicy
				193	has been removed from long-lasting storage.
				194
				195	Args:
				196	name: string, Required. Resource name for the access policy to delete.
				197
				198	Format `accessPolicies/{policy_id}` (required)
				199	x__xgafv: string, V1 error format.
				200	Allowed values
				201	1 - v1 error format
				202	2 - v2 error format
				203
				204	Returns:
				205	An object of the form:
				206
				207	{ # This resource represents a long-running operation that is the result of a
				208	# network API call.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	209	"name": "A String", # The server-assigned name, which is only unique within the same service that
				210	# originally returns it. If you use the default HTTP mapping, the
				211	# `name` should be a resource name ending with `operations/{unique_id}`.
				212	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				213	# different programming environments, including REST APIs and RPC APIs. It is
				214	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				215	# three pieces of data: error code, error message, and error details.
				216	#
				217	# You can find out more about this error model and how to work with it in the
				218	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				219	"message": "A String", # A developer-facing error message, which should be in English. Any
				220	# user-facing error message should be localized and sent in the
				221	# google.rpc.Status.details field, or localized by the client.
				222	"details": [ # A list of messages that carry the error details. There is a common set of
				223	# message types for APIs to use.
				224	{
				225	"a_key": "", # Properties of the object. Contains field @type with type URL.
				226	},
				227	],
				228	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				229	},
				230	"metadata": { # Service-specific metadata associated with the operation. It typically
				231	# contains progress information and common metadata such as create time.
				232	# Some services might not provide such metadata. Any method that returns a
				233	# long-running operation should document the metadata type, if any.
				234	"a_key": "", # Properties of the object. Contains field @type with type URL.
				235	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	236	"done": True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	237	# If `true`, the operation is completed, and either `error` or `response` is
				238	# available.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	239	"response": { # The normal response of the operation in case of success. If the original
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	240	# method returns no data on success, such as `Delete`, the response is
				241	# `google.protobuf.Empty`. If the original method is standard
				242	# `Get`/`Create`/`Update`, the response should be the resource. For other
				243	# methods, the response should have the type `XxxResponse`, where `Xxx`
				244	# is the original method name. For example, if the original method name
				245	# is `TakeSnapshot()`, the inferred response type is
				246	# `TakeSnapshotResponse`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	247	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	248	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	249	}</pre>
				250	</div>
				251
				252	<div class="method">
				253	<code class="details" id="get">get(name, x__xgafv=None)</code>
				254	<pre>Get an AccessPolicy by name.
				255
				256	Args:
				257	name: string, Required. Resource name for the access policy to get.
				258
				259	Format `accessPolicies/{policy_id}` (required)
				260	x__xgafv: string, V1 error format.
				261	Allowed values
				262	1 - v1 error format
				263	2 - v2 error format
				264
				265	Returns:
				266	An object of the form:
				267
				268	{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	269	# attributes to use Google Cloud services) and `ServicePerimeters` (which
				270	# define regions of services able to freely pass data within a perimeter). An
				271	# access policy is globally visible within an organization, and the
				272	# restrictions it specifies apply to all projects within an organization.
				273	"name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
				274	# `accessPolicies/{policy_id}`
				275	"etag": "A String", # Output only. An opaque identifier for the current version of the
				276	# `AccessPolicy`. This will always be a strongly validated etag, meaning that
				277	# two Access Polices will be identical if and only if their etags are
				278	# identical. Clients should not expect this to be in any specific format.
				279	"parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
				280	# Hierarchy. Currently immutable once created. Format:
				281	# `organizations/{organization_id}`
				282	"title": "A String", # Required. Human readable title. Does not affect behavior.
				283	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	284	</div>
				285
				286	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	287	<code class="details" id="list">list(pageToken=None, pageSize=None, parent=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	288	<pre>List all AccessPolicies under a
				289	container.
				290
				291	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	292	pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to
				293	the first page of results.
				294	pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	295	parent: string, Required. Resource name for the container to list AccessPolicy instances
				296	from.
				297
				298	Format:
				299	`organizations/{org_id}`
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	300	x__xgafv: string, V1 error format.
				301	Allowed values
				302	1 - v1 error format
				303	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	304
				305	Returns:
				306	An object of the form:
				307
				308	{ # A response to `ListAccessPoliciesRequest`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	309	"nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
				310	# empty, no further results remain.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	311	"accessPolicies": [ # List of the AccessPolicy instances.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	312	{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	313	# attributes to use Google Cloud services) and `ServicePerimeters` (which
				314	# define regions of services able to freely pass data within a perimeter). An
				315	# access policy is globally visible within an organization, and the
				316	# restrictions it specifies apply to all projects within an organization.
				317	"name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
				318	# `accessPolicies/{policy_id}`
				319	"etag": "A String", # Output only. An opaque identifier for the current version of the
				320	# `AccessPolicy`. This will always be a strongly validated etag, meaning that
				321	# two Access Polices will be identical if and only if their etags are
				322	# identical. Clients should not expect this to be in any specific format.
				323	"parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
				324	# Hierarchy. Currently immutable once created. Format:
				325	# `organizations/{organization_id}`
				326	"title": "A String", # Required. Human readable title. Does not affect behavior.
				327	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	328	],
				329	}</pre>
				330	</div>
				331
				332	<div class="method">
				333	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				334	<pre>Retrieves the next page of results.
				335
				336	Args:
				337	previous_request: The request for the previous page. (required)
				338	previous_response: The response from the request for the previous page. (required)
				339
				340	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	341	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]	342	page. Returns None if there are no more items in the collection.
				343	</pre>
				344	</div>
				345
				346	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	347	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	348	<pre>Update an AccessPolicy. The
				349	longrunning Operation from this RPC will have a successful status once the
				350	changes to the AccessPolicy have propagated
				351	to long-lasting storage. Syntactic and basic semantic errors will be
				352	returned in `metadata` as a BadRequest proto.
				353
				354	Args:
				355	name: string, Output only. Resource name of the `AccessPolicy`. Format:
				356	`accessPolicies/{policy_id}` (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	357	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	358	The object takes the form of:
				359
				360	{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	361	# attributes to use Google Cloud services) and `ServicePerimeters` (which
				362	# define regions of services able to freely pass data within a perimeter). An
				363	# access policy is globally visible within an organization, and the
				364	# restrictions it specifies apply to all projects within an organization.
				365	"name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
				366	# `accessPolicies/{policy_id}`
				367	"etag": "A String", # Output only. An opaque identifier for the current version of the
				368	# `AccessPolicy`. This will always be a strongly validated etag, meaning that
				369	# two Access Polices will be identical if and only if their etags are
				370	# identical. Clients should not expect this to be in any specific format.
				371	"parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
				372	# Hierarchy. Currently immutable once created. Format:
				373	# `organizations/{organization_id}`
				374	"title": "A String", # Required. Human readable title. Does not affect behavior.
				375	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	376
				377	updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
				378	x__xgafv: string, V1 error format.
				379	Allowed values
				380	1 - v1 error format
				381	2 - v2 error format
				382
				383	Returns:
				384	An object of the form:
				385
				386	{ # This resource represents a long-running operation that is the result of a
				387	# network API call.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	388	"name": "A String", # The server-assigned name, which is only unique within the same service that
				389	# originally returns it. If you use the default HTTP mapping, the
				390	# `name` should be a resource name ending with `operations/{unique_id}`.
				391	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				392	# different programming environments, including REST APIs and RPC APIs. It is
				393	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				394	# three pieces of data: error code, error message, and error details.
				395	#
				396	# You can find out more about this error model and how to work with it in the
				397	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				398	"message": "A String", # A developer-facing error message, which should be in English. Any
				399	# user-facing error message should be localized and sent in the
				400	# google.rpc.Status.details field, or localized by the client.
				401	"details": [ # A list of messages that carry the error details. There is a common set of
				402	# message types for APIs to use.
				403	{
				404	"a_key": "", # Properties of the object. Contains field @type with type URL.
				405	},
				406	],
				407	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				408	},
				409	"metadata": { # Service-specific metadata associated with the operation. It typically
				410	# contains progress information and common metadata such as create time.
				411	# Some services might not provide such metadata. Any method that returns a
				412	# long-running operation should document the metadata type, if any.
				413	"a_key": "", # Properties of the object. Contains field @type with type URL.
				414	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	415	"done": True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	416	# If `true`, the operation is completed, and either `error` or `response` is
				417	# available.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	418	"response": { # The normal response of the operation in case of success. If the original
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	419	# method returns no data on success, such as `Delete`, the response is
				420	# `google.protobuf.Empty`. If the original method is standard
				421	# `Get`/`Create`/`Update`, the response should be the resource. For other
				422	# methods, the response should have the type `XxxResponse`, where `Xxx`
				423	# is the original method name. For example, if the original method name
				424	# is `TakeSnapshot()`, the inferred response type is
				425	# `TakeSnapshotResponse`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	426	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	427	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	428	}</pre>
				429	</div>
				430
				431	</body></html>