Blame - docs/dyn/vault_v1.matters.holds.accounts.html - platform/external/python/google-api-python-client

blob: 88e7d2b9934629639857c3bb7834a4a82dc8121a [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="vault_v1.html">G Suite Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.holds.html">holds</a> . <a href="vault_v1.matters.holds.accounts.html">accounts</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#create">create(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Adds a HeldAccount to a hold. Accounts can only be added to a hold that</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(matterId, holdId, accountId, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Removes a HeldAccount from a hold. If this request leaves the hold with</p>
				83	<p class="toc_element">
				84	<code><a href="#list">list(matterId, holdId, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Lists HeldAccounts for a hold. This will only list individually specified</p>
				86	<h3>Method Details</h3>
				87	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	88	<code class="details" id="create">create(matterId, holdId, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	89	<pre>Adds a HeldAccount to a hold. Accounts can only be added to a hold that
				90	has no held_org_unit set. Attempting to add an account to an OU-based
				91	hold will result in an error.
				92
				93	Args:
				94	matterId: string, The matter ID. (required)
				95	holdId: string, The hold ID. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	The object takes the form of:
				98
				99	{ # An account being held in a particular hold. This structure is immutable.
				100	# This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	101	"firstName": "A String", # Output only. The first name of the account holder.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	102	"holdTime": "A String", # Output only. When the account was put on hold.
				103	"lastName": "A String", # Output only. The last name of the account holder.
				104	"email": "A String", # The primary email address of the account. If used as an input, this takes
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	105	# precedence over account ID.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	106	"accountId": "A String", # The account's ID as provided by the
				107	# <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	108	}
				109
				110	x__xgafv: string, V1 error format.
				111	Allowed values
				112	1 - v1 error format
				113	2 - v2 error format
				114
				115	Returns:
				116	An object of the form:
				117
				118	{ # An account being held in a particular hold. This structure is immutable.
				119	# This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	120	"firstName": "A String", # Output only. The first name of the account holder.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	121	"holdTime": "A String", # Output only. When the account was put on hold.
				122	"lastName": "A String", # Output only. The last name of the account holder.
				123	"email": "A String", # The primary email address of the account. If used as an input, this takes
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	124	# precedence over account ID.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	125	"accountId": "A String", # The account's ID as provided by the
				126	# <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127	}</pre>
				128	</div>
				129
				130	<div class="method">
				131	<code class="details" id="delete">delete(matterId, holdId, accountId, x__xgafv=None)</code>
				132	<pre>Removes a HeldAccount from a hold. If this request leaves the hold with
				133	no held accounts, the hold will not apply to any accounts.
				134
				135	Args:
				136	matterId: string, The matter ID. (required)
				137	holdId: string, The hold ID. (required)
				138	accountId: string, The ID of the account to remove from the hold. (required)
				139	x__xgafv: string, V1 error format.
				140	Allowed values
				141	1 - v1 error format
				142	2 - v2 error format
				143
				144	Returns:
				145	An object of the form:
				146
				147	{ # A generic empty message that you can re-use to avoid defining duplicated
				148	# empty messages in your APIs. A typical example is to use it as the request
				149	# or the response type of an API method. For instance:
				150	#
				151	# service Foo {
				152	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				153	# }
				154	#
				155	# The JSON representation for `Empty` is empty JSON object `{}`.
				156	}</pre>
				157	</div>
				158
				159	<div class="method">
				160	<code class="details" id="list">list(matterId, holdId, x__xgafv=None)</code>
				161	<pre>Lists HeldAccounts for a hold. This will only list individually specified
				162	held accounts. If the hold is on an OU, then use
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	163	<a href="https://developers.google.com/admin-sdk/">Admin SDK</a>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	164	to enumerate its members.
				165
				166	Args:
				167	matterId: string, The matter ID. (required)
				168	holdId: string, The hold ID. (required)
				169	x__xgafv: string, V1 error format.
				170	Allowed values
				171	1 - v1 error format
				172	2 - v2 error format
				173
				174	Returns:
				175	An object of the form:
				176
				177	{ # Returns a list of held accounts for a hold.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	178	"accounts": [ # The held accounts on a hold.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	179	{ # An account being held in a particular hold. This structure is immutable.
				180	# This can be either a single user or a google group, depending on the corpus.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	181	"firstName": "A String", # Output only. The first name of the account holder.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	182	"holdTime": "A String", # Output only. When the account was put on hold.
				183	"lastName": "A String", # Output only. The last name of the account holder.
				184	"email": "A String", # The primary email address of the account. If used as an input, this takes
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	185	# precedence over account ID.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	186	"accountId": "A String", # The account's ID as provided by the
				187	# <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	188	},
				189	],
				190	}</pre>
				191	</div>
				192
				193	</body></html>