Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / healthcare_v1beta1.projects.locations.datasets.html
blob: 487ef9bb26afba5242f5f59334d5093462e80be9 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="healthcare_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="healthcare_v1beta1.projects.locations.datasets.annotationStores.html">annotationStores()</a></code>
79</p>
80<p class="firstline">Returns the annotationStores Resource.</p>
81
82<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <code><a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.html">dicomStores()</a></code>
84</p>
85<p class="firstline">Returns the dicomStores Resource.</p>
86
87<p class="toc_element">
88 <code><a href="healthcare_v1beta1.projects.locations.datasets.fhirStores.html">fhirStores()</a></code>
89</p>
90<p class="firstline">Returns the fhirStores Resource.</p>
91
92<p class="toc_element">
93 <code><a href="healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html">hl7V2Stores()</a></code>
94</p>
95<p class="firstline">Returns the hl7V2Stores Resource.</p>
96
97<p class="toc_element">
98 <code><a href="healthcare_v1beta1.projects.locations.datasets.operations.html">operations()</a></code>
99</p>
100<p class="firstline">Returns the operations Resource.</p>
101
102<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code><a href="#create">create(parent, body=None, x__xgafv=None, datasetId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104<p class="firstline">Creates a new health dataset. Results are returned through the</p>
105<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]106 <code><a href="#deidentify">deidentify(sourceDataset, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107<p class="firstline">Creates a new dataset containing de-identified data from the source</p>
108<p class="toc_element">
109 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
110<p class="firstline">Deletes the specified health dataset and all data contained in the dataset.</p>
111<p class="toc_element">
112 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
113<p class="firstline">Gets any metadata associated with a dataset.</p>
114<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116<p class="firstline">Gets the access control policy for a resource.</p>
117<p class="toc_element">
118 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
119<p class="firstline">Lists the health datasets in the current project.</p>
120<p class="toc_element">
121 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
122<p class="firstline">Retrieves the next page of results.</p>
123<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125<p class="firstline">Updates dataset metadata.</p>
126<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
129<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
132<h3>Method Details</h3>
133<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]134 <code class="details" id="create">create(parent, body=None, x__xgafv=None, datasetId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 <pre>Creates a new health dataset. Results are returned through the
136Operation interface which returns either an
137`Operation.response` which contains a Dataset or
138`Operation.error`. The metadata
139field type is OperationMetadata.
140A Google Cloud Platform project can contain up to 500 datasets across all
141regions.
142
143Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144 parent: string, The name of the project where the server creates the dataset. For
145example, `projects/{project_id}/locations/{location_id}`. (required)
146 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 The object takes the form of:
148
149{ # A message representing a health dataset.
150 #
151 # A health dataset represents a collection of healthcare data pertaining to one
152 # or more patients. This may include multiple modalities of healthcare data,
153 # such as electronic medical records or medical imaging data.
154 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
155 # time zone name such as "America/New_York" or empty, which defaults to UTC.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 # This is used for parsing times in resources, such as HL7 messages, where no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 # explicit timezone is specified.
158 "name": "A String", # Output only. Resource name of the dataset, of the form
159 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
160}
161
162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166 datasetId: string, The ID of the dataset that is being created.
167The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.
168
169Returns:
170 An object of the form:
171
172 { # This resource represents a long-running operation that is the result of a
173 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]174 "metadata": { # Service-specific metadata associated with the operation. It typically
175 # contains progress information and common metadata such as create time.
176 # Some services might not provide such metadata. Any method that returns a
177 # long-running operation should document the metadata type, if any.
178 "a_key": "", # Properties of the object. Contains field @type with type URL.
179 },
180 "done": True or False, # If the value is `false`, it means the operation is still in progress.
181 # If `true`, the operation is completed, and either `error` or `response` is
182 # available.
183 "response": { # The normal response of the operation in case of success. If the original
184 # method returns no data on success, such as `Delete`, the response is
185 # `google.protobuf.Empty`. If the original method is standard
186 # `Get`/`Create`/`Update`, the response should be the resource. For other
187 # methods, the response should have the type `XxxResponse`, where `Xxx`
188 # is the original method name. For example, if the original method name
189 # is `TakeSnapshot()`, the inferred response type is
190 # `TakeSnapshotResponse`.
191 "a_key": "", # Properties of the object. Contains field @type with type URL.
192 },
193 "name": "A String", # The server-assigned name, which is only unique within the same service that
194 # originally returns it. If you use the default HTTP mapping, the
195 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 "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.
197 # different programming environments, including REST APIs and RPC APIs. It is
198 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
199 # three pieces of data: error code, error message, and error details.
200 #
201 # You can find out more about this error model and how to work with it in the
202 # [API Design Guide](https://cloud.google.com/apis/design/errors).
203 "message": "A String", # A developer-facing error message, which should be in English. Any
204 # user-facing error message should be localized and sent in the
205 # google.rpc.Status.details field, or localized by the client.
206 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
207 "details": [ # A list of messages that carry the error details. There is a common set of
208 # message types for APIs to use.
209 {
210 "a_key": "", # Properties of the object. Contains field @type with type URL.
211 },
212 ],
213 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 }</pre>
215</div>
216
217<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]218 <code class="details" id="deidentify">deidentify(sourceDataset, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 <pre>Creates a new dataset containing de-identified data from the source
220dataset. The metadata field type
221is OperationMetadata.
222If the request is successful, the
223response field type is
224DeidentifySummary.
225If errors occur,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]226error
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]227details field type is
228DeidentifyErrorDetails.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]229The LRO result may still be successful if de-identification fails for some
230DICOM instances. The new de-identified dataset will not contain these
231failed resources. Failed resource totals are tracked in
232DeidentifySummary.failure_resource_count.
233Error details are also logged to Stackdriver Logging. For more information,
234see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235
236Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]237 sourceDataset: string, Source dataset resource name. For example,
238`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. (required)
239 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 The object takes the form of:
241
242{ # Redacts identifying information from the specified dataset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]243 "destinationDataset": "A String", # The name of the dataset resource to create and write the redacted data to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 #
245 # * The destination dataset must not exist.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]246 # * The destination dataset must be in the same project and location as the
247 # source dataset. De-identifying data across multiple projects or locations
248 # is not supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "config": { # Configures de-id options specific to different types of content. # Deidentify configuration.
250 # Each submessage customizes the handling of an
251 # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are
252 # applied in a nested manner at runtime.
253 "text": { # Configures de-identification of text wherever it is found in the
254 # source_dataset.
255 "transformations": [ # The transformations to apply to the detected data.
256 { # A transformation to apply to text that is identified as a specific
257 # info_type.
258 "characterMaskConfig": { # Mask a string by replacing its characters with a fixed character. # Config for character mask.
259 "maskingCharacter": "A String", # Character to mask the sensitive values. If not supplied, defaults to "*".
260 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]261 "redactConfig": { # Define how to redact sensitive values. Default behaviour is erase. # Config for text redaction.
262 # For example, "My name is Jane." becomes "My name is ."
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 "replaceWithInfoTypeConfig": { # When using the # Config for replace with InfoType.
265 # INSPECT_AND_TRANSFORM
266 # action, each match is replaced with the name of the info_type. For example,
267 # "My name is Jane" becomes "My name is [PERSON_NAME]." The
268 # TRANSFORM
269 # action is equivalent to redacting.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]270 },
271 "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. # Config for crypto hash.
272 # Uses SHA-256.
273 # Outputs a base64-encoded representation of the hashed output
274 # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`).
275 "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 # key. A default key is generated for each Deidentify operation and is used
277 # wherever crypto_key is not specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]279 "infoTypes": [ # InfoTypes to apply this transformation to. If this is not specified, this
280 # transformation becomes the default transformation, and is used for any
281 # info_type that is not specified in another transformation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 "A String",
283 ],
284 "dateShiftConfig": { # Shift a date forward or backward in time by a random amount which is # Config for date shift.
285 # consistent for a given patient and crypto key combination.
286 "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this
287 # key and the patient ID. A default key is generated for each
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]288 # Deidentify operation and is used wherever crypto_key is not specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 },
290 },
291 ],
292 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]293 "image": { # Specifies how to handle de-identification of image pixels. # Configures de-identification of image pixels wherever they are found in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 # source_dataset.
295 "textRedactionMode": "A String", # Determines how to redact text from image.
296 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]297 "fhir": { # Specifies how to handle de-identification of a FHIR store. # Configures de-id of application/FHIR content.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298 "fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]299 # is not matched by a FieldMetadata is passed through to the output
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 # dataset unmodified. All extensions are removed in the output.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 # If a field can be matched by more than one FieldMetadata, the first
302 # FieldMetadata.Action is applied.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]303 { # Specifies FHIR paths to match, and how to handle de-identification of
304 # matching fields.
305 "action": "A String", # Deidentify action for one field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 "paths": [ # List of paths to FHIR fields to redact. Each path is a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 # period-separated list where each component is either a field name or
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]308 # FHIR type name. All types begin with an upper case letter. For example,
309 # the resource field "Patient.Address.city", which uses a string type,
310 # can be matched by "Patient.Address.String". Path also supports partial
311 # matching. For example, "Patient.Address.city" can be matched by
312 # "Address.city" (Patient omitted). Partial matching and type matching
313 # can be combined, for example "Patient.Address.city" can be matched by
314 # "Address.String". For "choice" types (those defined in the FHIR spec
315 # with the form: field[x]), use two separate components. For example,
316 # "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types
317 # are: AdministrativeGenderCode, Code, Date, DateTime, Decimal,
318 # HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
319 # The sub-type for HumanName(for example HumanName.given,
320 # HumanName.family) can be omitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]321 "A String",
322 ],
323 },
324 ],
325 },
326 "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content.
327 "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove.
328 "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags.
329 "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta
330 # Elements, or Directory Structuring Elements, as defined at:
331 # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
332 # They may be provided by "Keyword" or "Tag". For example "PatientID",
333 # "00100010".
334 "A String",
335 ],
336 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]337 "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID,
338 # SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched.
339 # The Cloud Healthcare API regenerates these UIDs by default based on the
340 # DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly
341 # to an individual out of context, given access to the original images, or
342 # to a database of the original images containing the UIDs, it would be
343 # possible to recover the individual's identity."
344 # http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags.
346 "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta
347 # Elements, or Directory Structuring Elements, as defined at:
348 # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
349 # They may be provided by "Keyword" or "Tag". For example "PatientID",
350 # "00100010".
351 "A String",
352 ],
353 },
354 },
355 },
356 }
357
358 x__xgafv: string, V1 error format.
359 Allowed values
360 1 - v1 error format
361 2 - v2 error format
362
363Returns:
364 An object of the form:
365
366 { # This resource represents a long-running operation that is the result of a
367 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]368 "metadata": { # Service-specific metadata associated with the operation. It typically
369 # contains progress information and common metadata such as create time.
370 # Some services might not provide such metadata. Any method that returns a
371 # long-running operation should document the metadata type, if any.
372 "a_key": "", # Properties of the object. Contains field @type with type URL.
373 },
374 "done": True or False, # If the value is `false`, it means the operation is still in progress.
375 # If `true`, the operation is completed, and either `error` or `response` is
376 # available.
377 "response": { # The normal response of the operation in case of success. If the original
378 # method returns no data on success, such as `Delete`, the response is
379 # `google.protobuf.Empty`. If the original method is standard
380 # `Get`/`Create`/`Update`, the response should be the resource. For other
381 # methods, the response should have the type `XxxResponse`, where `Xxx`
382 # is the original method name. For example, if the original method name
383 # is `TakeSnapshot()`, the inferred response type is
384 # `TakeSnapshotResponse`.
385 "a_key": "", # Properties of the object. Contains field @type with type URL.
386 },
387 "name": "A String", # The server-assigned name, which is only unique within the same service that
388 # originally returns it. If you use the default HTTP mapping, the
389 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 "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.
391 # different programming environments, including REST APIs and RPC APIs. It is
392 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
393 # three pieces of data: error code, error message, and error details.
394 #
395 # You can find out more about this error model and how to work with it in the
396 # [API Design Guide](https://cloud.google.com/apis/design/errors).
397 "message": "A String", # A developer-facing error message, which should be in English. Any
398 # user-facing error message should be localized and sent in the
399 # google.rpc.Status.details field, or localized by the client.
400 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
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 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]408 }</pre>
409</div>
410
411<div class="method">
412 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
413 <pre>Deletes the specified health dataset and all data contained in the dataset.
414Deleting a dataset does not affect the sources from which the dataset was
415imported (if any).
416
417Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 name: string, The name of the dataset to delete. For example,
419`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]420 x__xgafv: string, V1 error format.
421 Allowed values
422 1 - v1 error format
423 2 - v2 error format
424
425Returns:
426 An object of the form:
427
428 { # A generic empty message that you can re-use to avoid defining duplicated
429 # empty messages in your APIs. A typical example is to use it as the request
430 # or the response type of an API method. For instance:
431 #
432 # service Foo {
433 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
434 # }
435 #
436 # The JSON representation for `Empty` is empty JSON object `{}`.
437 }</pre>
438</div>
439
440<div class="method">
441 <code class="details" id="get">get(name, x__xgafv=None)</code>
442 <pre>Gets any metadata associated with a dataset.
443
444Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]445 name: string, The name of the dataset to read. For example,
446`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]447 x__xgafv: string, V1 error format.
448 Allowed values
449 1 - v1 error format
450 2 - v2 error format
451
452Returns:
453 An object of the form:
454
455 { # A message representing a health dataset.
456 #
457 # A health dataset represents a collection of healthcare data pertaining to one
458 # or more patients. This may include multiple modalities of healthcare data,
459 # such as electronic medical records or medical imaging data.
460 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
461 # time zone name such as "America/New_York" or empty, which defaults to UTC.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462 # This is used for parsing times in resources, such as HL7 messages, where no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463 # explicit timezone is specified.
464 "name": "A String", # Output only. Resource name of the dataset, of the form
465 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
466 }</pre>
467</div>
468
469<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]470 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471 <pre>Gets the access control policy for a resource.
472Returns an empty policy if the resource exists and does not have a policy
473set.
474
475Args:
476 resource: string, REQUIRED: The resource for which the policy is being requested.
477See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]478 options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.
479
480Valid values are 0, 1, and 3. Requests specifying an invalid value will be
481rejected.
482
483Requests for policies with any conditional bindings must specify version 3.
484Policies without any conditional bindings may specify any valid value or
485leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]486 x__xgafv: string, V1 error format.
487 Allowed values
488 1 - v1 error format
489 2 - v2 error format
490
491Returns:
492 An object of the form:
493
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]494 { # An Identity and Access Management (IAM) policy, which specifies access
495 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]496 #
497 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]498 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
499 # `members` to a single `role`. Members can be user accounts, service accounts,
500 # Google groups, and domains (such as G Suite). A `role` is a named list of
501 # permissions; each `role` can be an IAM predefined role or a user-created
502 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]503 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]504 # Optionally, a `binding` can specify a `condition`, which is a logical
505 # expression that allows access to a resource only if the expression evaluates
506 # to `true`. A condition can add constraints based on attributes of the
507 # request, the resource, or both.
508 #
509 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]510 #
511 # {
512 # "bindings": [
513 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]514 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]515 # "members": [
516 # "user:mike@example.com",
517 # "group:admins@example.com",
518 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]519 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520 # ]
521 # },
522 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]523 # "role": "roles/resourcemanager.organizationViewer",
524 # "members": ["user:eve@example.com"],
525 # "condition": {
526 # "title": "expirable access",
527 # "description": "Does not grant access after Sep 2020",
528 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
529 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]530 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]531 # ],
532 # "etag": "BwWWja0YfJA=",
533 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]534 # }
535 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]536 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]537 #
538 # bindings:
539 # - members:
540 # - user:mike@example.com
541 # - group:admins@example.com
542 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]543 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
544 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]545 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]546 # - user:eve@example.com
547 # role: roles/resourcemanager.organizationViewer
548 # condition:
549 # title: expirable access
550 # description: Does not grant access after Sep 2020
551 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
552 # - etag: BwWWja0YfJA=
553 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]554 #
555 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]556 # [IAM documentation](https://cloud.google.com/iam/docs/).
557 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
558 # `condition` that determines how and when the `bindings` are applied. Each
559 # of the `bindings` must contain at least one member.
560 { # Associates `members` with a `role`.
561 "role": "A String", # Role that is assigned to `members`.
562 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
563 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
564 # `members` can have the following values:
565 #
566 # * `allUsers`: A special identifier that represents anyone who is
567 # on the internet; with or without a Google account.
568 #
569 # * `allAuthenticatedUsers`: A special identifier that represents anyone
570 # who is authenticated with a Google account or a service account.
571 #
572 # * `user:{emailid}`: An email address that represents a specific Google
573 # account. For example, `alice@example.com` .
574 #
575 #
576 # * `serviceAccount:{emailid}`: An email address that represents a service
577 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
578 #
579 # * `group:{emailid}`: An email address that represents a Google group.
580 # For example, `admins@example.com`.
581 #
582 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
583 # identifier) representing a user that has been recently deleted. For
584 # example, `alice@example.com?uid=123456789012345678901`. If the user is
585 # recovered, this value reverts to `user:{emailid}` and the recovered user
586 # retains the role in the binding.
587 #
588 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
589 # unique identifier) representing a service account that has been recently
590 # deleted. For example,
591 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
592 # If the service account is undeleted, this value reverts to
593 # `serviceAccount:{emailid}` and the undeleted service account retains the
594 # role in the binding.
595 #
596 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
597 # identifier) representing a Google group that has been recently
598 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
599 # the group is recovered, this value reverts to `group:{emailid}` and the
600 # recovered group retains the role in the binding.
601 #
602 #
603 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
604 # users of that domain. For example, `google.com` or `example.com`.
605 #
606 "A String",
607 ],
608 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
609 # NOTE: An unsatisfied condition will not allow user access via current
610 # binding. Different bindings, including their conditions, are examined
611 # independently.
612 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
613 # are documented at https://github.com/google/cel-spec.
614 #
615 # Example (Comparison):
616 #
617 # title: "Summary size limit"
618 # description: "Determines if a summary is less than 100 chars"
619 # expression: "document.summary.size() &lt; 100"
620 #
621 # Example (Equality):
622 #
623 # title: "Requestor is owner"
624 # description: "Determines if requestor is the document owner"
625 # expression: "document.owner == request.auth.claims.email"
626 #
627 # Example (Logic):
628 #
629 # title: "Public documents"
630 # description: "Determine whether the document should be publicly visible"
631 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
632 #
633 # Example (Data Manipulation):
634 #
635 # title: "Notification string"
636 # description: "Create a notification string with a timestamp."
637 # expression: "'New message received at ' + string(document.create_time)"
638 #
639 # The exact variables and functions that may be referenced within an expression
640 # are determined by the service that evaluates it. See the service
641 # documentation for additional information.
642 "description": "A String", # Optional. Description of the expression. This is a longer text which
643 # describes the expression, e.g. when hovered over it in a UI.
644 "expression": "A String", # Textual representation of an expression in Common Expression Language
645 # syntax.
646 "location": "A String", # Optional. String indicating the location of the expression for error
647 # reporting, e.g. a file name and a position in the file.
648 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
649 # its purpose. This can be used e.g. in UIs which allow to enter the
650 # expression.
651 },
652 },
653 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]654 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
655 { # Specifies the audit configuration for a service.
656 # The configuration determines which permission types are logged, and what
657 # identities, if any, are exempted from logging.
658 # An AuditConfig must have one or more AuditLogConfigs.
659 #
660 # If there are AuditConfigs for both `allServices` and a specific service,
661 # the union of the two AuditConfigs is used for that service: the log_types
662 # specified in each AuditConfig are enabled, and the exempted_members in each
663 # AuditLogConfig are exempted.
664 #
665 # Example Policy with multiple AuditConfigs:
666 #
667 # {
668 # "audit_configs": [
669 # {
670 # "service": "allServices"
671 # "audit_log_configs": [
672 # {
673 # "log_type": "DATA_READ",
674 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]675 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]676 # ]
677 # },
678 # {
679 # "log_type": "DATA_WRITE",
680 # },
681 # {
682 # "log_type": "ADMIN_READ",
683 # }
684 # ]
685 # },
686 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]687 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]688 # "audit_log_configs": [
689 # {
690 # "log_type": "DATA_READ",
691 # },
692 # {
693 # "log_type": "DATA_WRITE",
694 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]695 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]696 # ]
697 # }
698 # ]
699 # }
700 # ]
701 # }
702 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]703 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
704 # logging. It also exempts jose@example.com from DATA_READ logging, and
705 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]706 "auditLogConfigs": [ # The configuration for logging of each type of permission.
707 { # Provides the configuration for logging a type of permissions.
708 # Example:
709 #
710 # {
711 # "audit_log_configs": [
712 # {
713 # "log_type": "DATA_READ",
714 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]715 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]716 # ]
717 # },
718 # {
719 # "log_type": "DATA_WRITE",
720 # }
721 # ]
722 # }
723 #
724 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]725 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]726 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
727 # permission.
728 # Follows the same format of Binding.members.
729 "A String",
730 ],
731 "logType": "A String", # The log type that this config enables.
732 },
733 ],
734 "service": "A String", # Specifies a service that will be enabled for audit logging.
735 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
736 # `allServices` is a special value that covers all services.
737 },
738 ],
739 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
740 # prevent simultaneous updates of a policy from overwriting each other.
741 # It is strongly suggested that systems make use of the `etag` in the
742 # read-modify-write cycle to perform policy updates in order to avoid race
743 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
744 # systems are expected to put that etag in the request to `setIamPolicy` to
745 # ensure that their change will be applied to the same version of the policy.
746 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]747 # **Important:** If you use IAM Conditions, you must include the `etag` field
748 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
749 # you to overwrite a version `3` policy with a version `1` policy, and all of
750 # the conditions in the version `3` policy are lost.
751 "version": 42, # Specifies the format of the policy.
752 #
753 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
754 # are rejected.
755 #
756 # Any operation that affects conditional role bindings must specify version
757 # `3`. This requirement applies to the following operations:
758 #
759 # * Getting a policy that includes a conditional role binding
760 # * Adding a conditional role binding to a policy
761 # * Changing a conditional role binding in a policy
762 # * Removing any role binding, with or without a condition, from a policy
763 # that includes conditions
764 #
765 # **Important:** If you use IAM Conditions, you must include the `etag` field
766 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
767 # you to overwrite a version `3` policy with a version `1` policy, and all of
768 # the conditions in the version `3` policy are lost.
769 #
770 # If a policy does not include any conditions, operations on that policy may
771 # specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]772 }</pre>
773</div>
774
775<div class="method">
776 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
777 <pre>Lists the health datasets in the current project.
778
779Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]780 parent: string, The name of the project whose datasets should be listed.
781For example, `projects/{project_id}/locations/{location_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]782 pageToken: string, The next_page_token value returned from a previous List request, if any.
783 x__xgafv: string, V1 error format.
784 Allowed values
785 1 - v1 error format
786 2 - v2 error format
787 pageSize: integer, The maximum number of items to return. Capped to 100 if not specified.
788May not be larger than 1000.
789
790Returns:
791 An object of the form:
792
793 { # Lists the available datasets.
794 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
795 # more results in the list.
796 "datasets": [ # The first page of datasets.
797 { # A message representing a health dataset.
798 #
799 # A health dataset represents a collection of healthcare data pertaining to one
800 # or more patients. This may include multiple modalities of healthcare data,
801 # such as electronic medical records or medical imaging data.
802 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
803 # time zone name such as "America/New_York" or empty, which defaults to UTC.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]804 # This is used for parsing times in resources, such as HL7 messages, where no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]805 # explicit timezone is specified.
806 "name": "A String", # Output only. Resource name of the dataset, of the form
807 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
808 },
809 ],
810 }</pre>
811</div>
812
813<div class="method">
814 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
815 <pre>Retrieves the next page of results.
816
817Args:
818 previous_request: The request for the previous page. (required)
819 previous_response: The response from the request for the previous page. (required)
820
821Returns:
822 A request object that you can call 'execute()' on to request the next
823 page. Returns None if there are no more items in the collection.
824 </pre>
825</div>
826
827<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]828 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]829 <pre>Updates dataset metadata.
830
831Args:
832 name: string, Output only. Resource name of the dataset, of the form
833`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]834 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]835 The object takes the form of:
836
837{ # A message representing a health dataset.
838 #
839 # A health dataset represents a collection of healthcare data pertaining to one
840 # or more patients. This may include multiple modalities of healthcare data,
841 # such as electronic medical records or medical imaging data.
842 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
843 # time zone name such as "America/New_York" or empty, which defaults to UTC.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]844 # This is used for parsing times in resources, such as HL7 messages, where no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]845 # explicit timezone is specified.
846 "name": "A String", # Output only. Resource name of the dataset, of the form
847 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
848}
849
850 updateMask: string, The update mask applies to the resource. For the `FieldMask` definition,
851see
852https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
853 x__xgafv: string, V1 error format.
854 Allowed values
855 1 - v1 error format
856 2 - v2 error format
857
858Returns:
859 An object of the form:
860
861 { # A message representing a health dataset.
862 #
863 # A health dataset represents a collection of healthcare data pertaining to one
864 # or more patients. This may include multiple modalities of healthcare data,
865 # such as electronic medical records or medical imaging data.
866 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
867 # time zone name such as "America/New_York" or empty, which defaults to UTC.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]868 # This is used for parsing times in resources, such as HL7 messages, where no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]869 # explicit timezone is specified.
870 "name": "A String", # Output only. Resource name of the dataset, of the form
871 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
872 }</pre>
873</div>
874
875<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]876 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]877 <pre>Sets the access control policy on the specified resource. Replaces any
878existing policy.
879
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]880Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
881
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]882Args:
883 resource: string, REQUIRED: The resource for which the policy is being specified.
884See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]885 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]886 The object takes the form of:
887
888{ # Request message for `SetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]889 "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]890 # the policy is limited to a few 10s of KB. An empty policy is a
891 # valid policy but certain Cloud Platform services (such as Projects)
892 # might reject them.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]893 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]894 #
895 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]896 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
897 # `members` to a single `role`. Members can be user accounts, service accounts,
898 # Google groups, and domains (such as G Suite). A `role` is a named list of
899 # permissions; each `role` can be an IAM predefined role or a user-created
900 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]901 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]902 # Optionally, a `binding` can specify a `condition`, which is a logical
903 # expression that allows access to a resource only if the expression evaluates
904 # to `true`. A condition can add constraints based on attributes of the
905 # request, the resource, or both.
906 #
907 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]908 #
909 # {
910 # "bindings": [
911 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]912 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]913 # "members": [
914 # "user:mike@example.com",
915 # "group:admins@example.com",
916 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]917 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]918 # ]
919 # },
920 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]921 # "role": "roles/resourcemanager.organizationViewer",
922 # "members": ["user:eve@example.com"],
923 # "condition": {
924 # "title": "expirable access",
925 # "description": "Does not grant access after Sep 2020",
926 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
927 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]928 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]929 # ],
930 # "etag": "BwWWja0YfJA=",
931 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]932 # }
933 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]934 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]935 #
936 # bindings:
937 # - members:
938 # - user:mike@example.com
939 # - group:admins@example.com
940 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]941 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
942 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]943 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]944 # - user:eve@example.com
945 # role: roles/resourcemanager.organizationViewer
946 # condition:
947 # title: expirable access
948 # description: Does not grant access after Sep 2020
949 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
950 # - etag: BwWWja0YfJA=
951 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]952 #
953 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]954 # [IAM documentation](https://cloud.google.com/iam/docs/).
955 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
956 # `condition` that determines how and when the `bindings` are applied. Each
957 # of the `bindings` must contain at least one member.
958 { # Associates `members` with a `role`.
959 "role": "A String", # Role that is assigned to `members`.
960 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
961 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
962 # `members` can have the following values:
963 #
964 # * `allUsers`: A special identifier that represents anyone who is
965 # on the internet; with or without a Google account.
966 #
967 # * `allAuthenticatedUsers`: A special identifier that represents anyone
968 # who is authenticated with a Google account or a service account.
969 #
970 # * `user:{emailid}`: An email address that represents a specific Google
971 # account. For example, `alice@example.com` .
972 #
973 #
974 # * `serviceAccount:{emailid}`: An email address that represents a service
975 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
976 #
977 # * `group:{emailid}`: An email address that represents a Google group.
978 # For example, `admins@example.com`.
979 #
980 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
981 # identifier) representing a user that has been recently deleted. For
982 # example, `alice@example.com?uid=123456789012345678901`. If the user is
983 # recovered, this value reverts to `user:{emailid}` and the recovered user
984 # retains the role in the binding.
985 #
986 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
987 # unique identifier) representing a service account that has been recently
988 # deleted. For example,
989 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
990 # If the service account is undeleted, this value reverts to
991 # `serviceAccount:{emailid}` and the undeleted service account retains the
992 # role in the binding.
993 #
994 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
995 # identifier) representing a Google group that has been recently
996 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
997 # the group is recovered, this value reverts to `group:{emailid}` and the
998 # recovered group retains the role in the binding.
999 #
1000 #
1001 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1002 # users of that domain. For example, `google.com` or `example.com`.
1003 #
1004 "A String",
1005 ],
1006 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1007 # NOTE: An unsatisfied condition will not allow user access via current
1008 # binding. Different bindings, including their conditions, are examined
1009 # independently.
1010 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1011 # are documented at https://github.com/google/cel-spec.
1012 #
1013 # Example (Comparison):
1014 #
1015 # title: "Summary size limit"
1016 # description: "Determines if a summary is less than 100 chars"
1017 # expression: "document.summary.size() &lt; 100"
1018 #
1019 # Example (Equality):
1020 #
1021 # title: "Requestor is owner"
1022 # description: "Determines if requestor is the document owner"
1023 # expression: "document.owner == request.auth.claims.email"
1024 #
1025 # Example (Logic):
1026 #
1027 # title: "Public documents"
1028 # description: "Determine whether the document should be publicly visible"
1029 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1030 #
1031 # Example (Data Manipulation):
1032 #
1033 # title: "Notification string"
1034 # description: "Create a notification string with a timestamp."
1035 # expression: "'New message received at ' + string(document.create_time)"
1036 #
1037 # The exact variables and functions that may be referenced within an expression
1038 # are determined by the service that evaluates it. See the service
1039 # documentation for additional information.
1040 "description": "A String", # Optional. Description of the expression. This is a longer text which
1041 # describes the expression, e.g. when hovered over it in a UI.
1042 "expression": "A String", # Textual representation of an expression in Common Expression Language
1043 # syntax.
1044 "location": "A String", # Optional. String indicating the location of the expression for error
1045 # reporting, e.g. a file name and a position in the file.
1046 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
1047 # its purpose. This can be used e.g. in UIs which allow to enter the
1048 # expression.
1049 },
1050 },
1051 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1052 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1053 { # Specifies the audit configuration for a service.
1054 # The configuration determines which permission types are logged, and what
1055 # identities, if any, are exempted from logging.
1056 # An AuditConfig must have one or more AuditLogConfigs.
1057 #
1058 # If there are AuditConfigs for both `allServices` and a specific service,
1059 # the union of the two AuditConfigs is used for that service: the log_types
1060 # specified in each AuditConfig are enabled, and the exempted_members in each
1061 # AuditLogConfig are exempted.
1062 #
1063 # Example Policy with multiple AuditConfigs:
1064 #
1065 # {
1066 # "audit_configs": [
1067 # {
1068 # "service": "allServices"
1069 # "audit_log_configs": [
1070 # {
1071 # "log_type": "DATA_READ",
1072 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1073 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1074 # ]
1075 # },
1076 # {
1077 # "log_type": "DATA_WRITE",
1078 # },
1079 # {
1080 # "log_type": "ADMIN_READ",
1081 # }
1082 # ]
1083 # },
1084 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1085 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1086 # "audit_log_configs": [
1087 # {
1088 # "log_type": "DATA_READ",
1089 # },
1090 # {
1091 # "log_type": "DATA_WRITE",
1092 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1093 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1094 # ]
1095 # }
1096 # ]
1097 # }
1098 # ]
1099 # }
1100 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1101 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1102 # logging. It also exempts jose@example.com from DATA_READ logging, and
1103 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1104 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1105 { # Provides the configuration for logging a type of permissions.
1106 # Example:
1107 #
1108 # {
1109 # "audit_log_configs": [
1110 # {
1111 # "log_type": "DATA_READ",
1112 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1113 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1114 # ]
1115 # },
1116 # {
1117 # "log_type": "DATA_WRITE",
1118 # }
1119 # ]
1120 # }
1121 #
1122 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1123 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1124 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1125 # permission.
1126 # Follows the same format of Binding.members.
1127 "A String",
1128 ],
1129 "logType": "A String", # The log type that this config enables.
1130 },
1131 ],
1132 "service": "A String", # Specifies a service that will be enabled for audit logging.
1133 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1134 # `allServices` is a special value that covers all services.
1135 },
1136 ],
1137 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1138 # prevent simultaneous updates of a policy from overwriting each other.
1139 # It is strongly suggested that systems make use of the `etag` in the
1140 # read-modify-write cycle to perform policy updates in order to avoid race
1141 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1142 # systems are expected to put that etag in the request to `setIamPolicy` to
1143 # ensure that their change will be applied to the same version of the policy.
1144 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1145 # **Important:** If you use IAM Conditions, you must include the `etag` field
1146 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1147 # you to overwrite a version `3` policy with a version `1` policy, and all of
1148 # the conditions in the version `3` policy are lost.
1149 "version": 42, # Specifies the format of the policy.
1150 #
1151 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1152 # are rejected.
1153 #
1154 # Any operation that affects conditional role bindings must specify version
1155 # `3`. This requirement applies to the following operations:
1156 #
1157 # * Getting a policy that includes a conditional role binding
1158 # * Adding a conditional role binding to a policy
1159 # * Changing a conditional role binding in a policy
1160 # * Removing any role binding, with or without a condition, from a policy
1161 # that includes conditions
1162 #
1163 # **Important:** If you use IAM Conditions, you must include the `etag` field
1164 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1165 # you to overwrite a version `3` policy with a version `1` policy, and all of
1166 # the conditions in the version `3` policy are lost.
1167 #
1168 # If a policy does not include any conditions, operations on that policy may
1169 # specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1170 },
1171 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
1172 # the fields in the mask will be modified. If no mask is provided, the
1173 # following default mask is used:
1174 # paths: "bindings, etag"
1175 # This field is only used by Cloud IAM.
1176 }
1177
1178 x__xgafv: string, V1 error format.
1179 Allowed values
1180 1 - v1 error format
1181 2 - v2 error format
1182
1183Returns:
1184 An object of the form:
1185
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1186 { # An Identity and Access Management (IAM) policy, which specifies access
1187 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1188 #
1189 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1190 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1191 # `members` to a single `role`. Members can be user accounts, service accounts,
1192 # Google groups, and domains (such as G Suite). A `role` is a named list of
1193 # permissions; each `role` can be an IAM predefined role or a user-created
1194 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1195 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1196 # Optionally, a `binding` can specify a `condition`, which is a logical
1197 # expression that allows access to a resource only if the expression evaluates
1198 # to `true`. A condition can add constraints based on attributes of the
1199 # request, the resource, or both.
1200 #
1201 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1202 #
1203 # {
1204 # "bindings": [
1205 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1206 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1207 # "members": [
1208 # "user:mike@example.com",
1209 # "group:admins@example.com",
1210 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1211 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1212 # ]
1213 # },
1214 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1215 # "role": "roles/resourcemanager.organizationViewer",
1216 # "members": ["user:eve@example.com"],
1217 # "condition": {
1218 # "title": "expirable access",
1219 # "description": "Does not grant access after Sep 2020",
1220 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1221 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1222 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1223 # ],
1224 # "etag": "BwWWja0YfJA=",
1225 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1226 # }
1227 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1228 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1229 #
1230 # bindings:
1231 # - members:
1232 # - user:mike@example.com
1233 # - group:admins@example.com
1234 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1235 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1236 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1237 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1238 # - user:eve@example.com
1239 # role: roles/resourcemanager.organizationViewer
1240 # condition:
1241 # title: expirable access
1242 # description: Does not grant access after Sep 2020
1243 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1244 # - etag: BwWWja0YfJA=
1245 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1246 #
1247 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1248 # [IAM documentation](https://cloud.google.com/iam/docs/).
1249 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1250 # `condition` that determines how and when the `bindings` are applied. Each
1251 # of the `bindings` must contain at least one member.
1252 { # Associates `members` with a `role`.
1253 "role": "A String", # Role that is assigned to `members`.
1254 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1255 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1256 # `members` can have the following values:
1257 #
1258 # * `allUsers`: A special identifier that represents anyone who is
1259 # on the internet; with or without a Google account.
1260 #
1261 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1262 # who is authenticated with a Google account or a service account.
1263 #
1264 # * `user:{emailid}`: An email address that represents a specific Google
1265 # account. For example, `alice@example.com` .
1266 #
1267 #
1268 # * `serviceAccount:{emailid}`: An email address that represents a service
1269 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1270 #
1271 # * `group:{emailid}`: An email address that represents a Google group.
1272 # For example, `admins@example.com`.
1273 #
1274 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1275 # identifier) representing a user that has been recently deleted. For
1276 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1277 # recovered, this value reverts to `user:{emailid}` and the recovered user
1278 # retains the role in the binding.
1279 #
1280 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1281 # unique identifier) representing a service account that has been recently
1282 # deleted. For example,
1283 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1284 # If the service account is undeleted, this value reverts to
1285 # `serviceAccount:{emailid}` and the undeleted service account retains the
1286 # role in the binding.
1287 #
1288 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1289 # identifier) representing a Google group that has been recently
1290 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1291 # the group is recovered, this value reverts to `group:{emailid}` and the
1292 # recovered group retains the role in the binding.
1293 #
1294 #
1295 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1296 # users of that domain. For example, `google.com` or `example.com`.
1297 #
1298 "A String",
1299 ],
1300 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1301 # NOTE: An unsatisfied condition will not allow user access via current
1302 # binding. Different bindings, including their conditions, are examined
1303 # independently.
1304 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1305 # are documented at https://github.com/google/cel-spec.
1306 #
1307 # Example (Comparison):
1308 #
1309 # title: "Summary size limit"
1310 # description: "Determines if a summary is less than 100 chars"
1311 # expression: "document.summary.size() &lt; 100"
1312 #
1313 # Example (Equality):
1314 #
1315 # title: "Requestor is owner"
1316 # description: "Determines if requestor is the document owner"
1317 # expression: "document.owner == request.auth.claims.email"
1318 #
1319 # Example (Logic):
1320 #
1321 # title: "Public documents"
1322 # description: "Determine whether the document should be publicly visible"
1323 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1324 #
1325 # Example (Data Manipulation):
1326 #
1327 # title: "Notification string"
1328 # description: "Create a notification string with a timestamp."
1329 # expression: "'New message received at ' + string(document.create_time)"
1330 #
1331 # The exact variables and functions that may be referenced within an expression
1332 # are determined by the service that evaluates it. See the service
1333 # documentation for additional information.
1334 "description": "A String", # Optional. Description of the expression. This is a longer text which
1335 # describes the expression, e.g. when hovered over it in a UI.
1336 "expression": "A String", # Textual representation of an expression in Common Expression Language
1337 # syntax.
1338 "location": "A String", # Optional. String indicating the location of the expression for error
1339 # reporting, e.g. a file name and a position in the file.
1340 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
1341 # its purpose. This can be used e.g. in UIs which allow to enter the
1342 # expression.
1343 },
1344 },
1345 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1346 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1347 { # Specifies the audit configuration for a service.
1348 # The configuration determines which permission types are logged, and what
1349 # identities, if any, are exempted from logging.
1350 # An AuditConfig must have one or more AuditLogConfigs.
1351 #
1352 # If there are AuditConfigs for both `allServices` and a specific service,
1353 # the union of the two AuditConfigs is used for that service: the log_types
1354 # specified in each AuditConfig are enabled, and the exempted_members in each
1355 # AuditLogConfig are exempted.
1356 #
1357 # Example Policy with multiple AuditConfigs:
1358 #
1359 # {
1360 # "audit_configs": [
1361 # {
1362 # "service": "allServices"
1363 # "audit_log_configs": [
1364 # {
1365 # "log_type": "DATA_READ",
1366 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1367 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1368 # ]
1369 # },
1370 # {
1371 # "log_type": "DATA_WRITE",
1372 # },
1373 # {
1374 # "log_type": "ADMIN_READ",
1375 # }
1376 # ]
1377 # },
1378 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1379 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1380 # "audit_log_configs": [
1381 # {
1382 # "log_type": "DATA_READ",
1383 # },
1384 # {
1385 # "log_type": "DATA_WRITE",
1386 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1387 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1388 # ]
1389 # }
1390 # ]
1391 # }
1392 # ]
1393 # }
1394 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1395 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1396 # logging. It also exempts jose@example.com from DATA_READ logging, and
1397 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1398 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1399 { # Provides the configuration for logging a type of permissions.
1400 # Example:
1401 #
1402 # {
1403 # "audit_log_configs": [
1404 # {
1405 # "log_type": "DATA_READ",
1406 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1407 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1408 # ]
1409 # },
1410 # {
1411 # "log_type": "DATA_WRITE",
1412 # }
1413 # ]
1414 # }
1415 #
1416 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1417 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1418 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1419 # permission.
1420 # Follows the same format of Binding.members.
1421 "A String",
1422 ],
1423 "logType": "A String", # The log type that this config enables.
1424 },
1425 ],
1426 "service": "A String", # Specifies a service that will be enabled for audit logging.
1427 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1428 # `allServices` is a special value that covers all services.
1429 },
1430 ],
1431 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1432 # prevent simultaneous updates of a policy from overwriting each other.
1433 # It is strongly suggested that systems make use of the `etag` in the
1434 # read-modify-write cycle to perform policy updates in order to avoid race
1435 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1436 # systems are expected to put that etag in the request to `setIamPolicy` to
1437 # ensure that their change will be applied to the same version of the policy.
1438 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1439 # **Important:** If you use IAM Conditions, you must include the `etag` field
1440 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1441 # you to overwrite a version `3` policy with a version `1` policy, and all of
1442 # the conditions in the version `3` policy are lost.
1443 "version": 42, # Specifies the format of the policy.
1444 #
1445 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1446 # are rejected.
1447 #
1448 # Any operation that affects conditional role bindings must specify version
1449 # `3`. This requirement applies to the following operations:
1450 #
1451 # * Getting a policy that includes a conditional role binding
1452 # * Adding a conditional role binding to a policy
1453 # * Changing a conditional role binding in a policy
1454 # * Removing any role binding, with or without a condition, from a policy
1455 # that includes conditions
1456 #
1457 # **Important:** If you use IAM Conditions, you must include the `etag` field
1458 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1459 # you to overwrite a version `3` policy with a version `1` policy, and all of
1460 # the conditions in the version `3` policy are lost.
1461 #
1462 # If a policy does not include any conditions, operations on that policy may
1463 # specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1464 }</pre>
1465</div>
1466
1467<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1468 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1469 <pre>Returns permissions that a caller has on the specified resource.
1470If the resource does not exist, this will return an empty set of
1471permissions, not a NOT_FOUND error.
1472
1473Note: This operation is designed to be used for building permission-aware
1474UIs and command-line tools, not for authorization checking. This operation
1475may "fail open" without warning.
1476
1477Args:
1478 resource: string, REQUIRED: The resource for which the policy detail is being requested.
1479See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1480 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1481 The object takes the form of:
1482
1483{ # Request message for `TestIamPermissions` method.
1484 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1485 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1486 # information see
1487 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1488 "A String",
1489 ],
1490 }
1491
1492 x__xgafv: string, V1 error format.
1493 Allowed values
1494 1 - v1 error format
1495 2 - v2 error format
1496
1497Returns:
1498 An object of the form:
1499
1500 { # Response message for `TestIamPermissions` method.
1501 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1502 # allowed.
1503 "A String",
1504 ],
1505 }</pre>
1506</div>
1507
1508</body></html>