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> . <a href="healthcare_v1beta1.projects.locations.datasets.consentStores.html">consentStores</a> . <a href="healthcare_v1beta1.projects.locations.datasets.consentStores.userDataMappings.html">userDataMappings</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#archive">archive(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Archives the specified User data mapping.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a new User data mapping in the parent consent store.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified User data mapping.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets the specified User data mapping.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists the User data mappings in the specified consent store.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates the specified User data mapping.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="archive">archive(name, body=None, x__xgafv=None)</code> 104 <pre>Archives the specified User data mapping. 105 106Args: 107 name: string, Required. The resource name of the User data mapping to archive. (required) 108 body: object, The request body. 109 The object takes the form of: 110 111{ # Archives the specified User data mapping. 112} 113 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # Archives the specified User data mapping. 123}</pre> 124</div> 125 126<div class="method"> 127 <code class="details" id="close">close()</code> 128 <pre>Close httplib2 connections.</pre> 129</div> 130 131<div class="method"> 132 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 133 <pre>Creates a new User data mapping in the parent consent store. 134 135Args: 136 parent: string, Required. Name of the consent store. (required) 137 body: object, The request body. 138 The object takes the form of: 139 140{ # Maps a resource to the associated user and Attributes. 141 "archiveTime": "A String", # Output only. Indicates the time when this mapping was archived. 142 "archived": True or False, # Output only. Indicates whether this mapping is archived. 143 "dataId": "A String", # Required. A unique identifier for the mapped resource. 144 "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. 145 "resourceAttributes": [ # Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. 146 { # An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values. 147 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 148 "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. 149 "A String", 150 ], 151 }, 152 ], 153 "userId": "A String", # Required. User's UUID provided by the client. 154} 155 156 x__xgafv: string, V1 error format. 157 Allowed values 158 1 - v1 error format 159 2 - v2 error format 160 161Returns: 162 An object of the form: 163 164 { # Maps a resource to the associated user and Attributes. 165 "archiveTime": "A String", # Output only. Indicates the time when this mapping was archived. 166 "archived": True or False, # Output only. Indicates whether this mapping is archived. 167 "dataId": "A String", # Required. A unique identifier for the mapped resource. 168 "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. 169 "resourceAttributes": [ # Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. 170 { # An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values. 171 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 172 "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. 173 "A String", 174 ], 175 }, 176 ], 177 "userId": "A String", # Required. User's UUID provided by the client. 178}</pre> 179</div> 180 181<div class="method"> 182 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 183 <pre>Deletes the specified User data mapping. 184 185Args: 186 name: string, Required. The resource name of the User data mapping to delete. (required) 187 x__xgafv: string, V1 error format. 188 Allowed values 189 1 - v1 error format 190 2 - v2 error format 191 192Returns: 193 An object of the form: 194 195 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 196}</pre> 197</div> 198 199<div class="method"> 200 <code class="details" id="get">get(name, x__xgafv=None)</code> 201 <pre>Gets the specified User data mapping. 202 203Args: 204 name: string, Required. The resource name of the User data mapping to retrieve. (required) 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { # Maps a resource to the associated user and Attributes. 214 "archiveTime": "A String", # Output only. Indicates the time when this mapping was archived. 215 "archived": True or False, # Output only. Indicates whether this mapping is archived. 216 "dataId": "A String", # Required. A unique identifier for the mapped resource. 217 "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. 218 "resourceAttributes": [ # Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. 219 { # An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values. 220 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 221 "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. 222 "A String", 223 ], 224 }, 225 ], 226 "userId": "A String", # Required. User's UUID provided by the client. 227}</pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 232 <pre>Lists the User data mappings in the specified consent store. 233 234Args: 235 parent: string, Required. Name of the consent store to retrieve User data mappings from. (required) 236 filter: string, Optional. Restricts the user data mappings returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - data_id - user_id. For example, `filter=user_id=\"user123\"`. - archived - archive_time 237 pageSize: integer, Optional. Limit on the number of User data mappings to return in a single response. If not specified, 100 is used. May not be larger than 1000. 238 pageToken: string, Optional. Token to retrieve the next page of results, or empty to get the first page. 239 x__xgafv: string, V1 error format. 240 Allowed values 241 1 - v1 error format 242 2 - v2 error format 243 244Returns: 245 An object of the form: 246 247 { 248 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 249 "userDataMappings": [ # The returned User data mappings. The maximum number of User data mappings returned is determined by the value of page_size in the ListUserDataMappingsRequest. 250 { # Maps a resource to the associated user and Attributes. 251 "archiveTime": "A String", # Output only. Indicates the time when this mapping was archived. 252 "archived": True or False, # Output only. Indicates whether this mapping is archived. 253 "dataId": "A String", # Required. A unique identifier for the mapped resource. 254 "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. 255 "resourceAttributes": [ # Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. 256 { # An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values. 257 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 258 "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. 259 "A String", 260 ], 261 }, 262 ], 263 "userId": "A String", # Required. User's UUID provided by the client. 264 }, 265 ], 266}</pre> 267</div> 268 269<div class="method"> 270 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 271 <pre>Retrieves the next page of results. 272 273Args: 274 previous_request: The request for the previous page. (required) 275 previous_response: The response from the request for the previous page. (required) 276 277Returns: 278 A request object that you can call 'execute()' on to request the next 279 page. Returns None if there are no more items in the collection. 280 </pre> 281</div> 282 283<div class="method"> 284 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 285 <pre>Updates the specified User data mapping. 286 287Args: 288 name: string, Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. (required) 289 body: object, The request body. 290 The object takes the form of: 291 292{ # Maps a resource to the associated user and Attributes. 293 "archiveTime": "A String", # Output only. Indicates the time when this mapping was archived. 294 "archived": True or False, # Output only. Indicates whether this mapping is archived. 295 "dataId": "A String", # Required. A unique identifier for the mapped resource. 296 "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. 297 "resourceAttributes": [ # Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. 298 { # An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values. 299 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 300 "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. 301 "A String", 302 ], 303 }, 304 ], 305 "userId": "A String", # Required. User's UUID provided by the client. 306} 307 308 updateMask: string, Required. The update mask that applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `data_id`, `user_id` and `resource_attributes` fields can be updated. 309 x__xgafv: string, V1 error format. 310 Allowed values 311 1 - v1 error format 312 2 - v2 error format 313 314Returns: 315 An object of the form: 316 317 { # Maps a resource to the associated user and Attributes. 318 "archiveTime": "A String", # Output only. Indicates the time when this mapping was archived. 319 "archived": True or False, # Output only. Indicates whether this mapping is archived. 320 "dataId": "A String", # Required. A unique identifier for the mapped resource. 321 "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. 322 "resourceAttributes": [ # Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. 323 { # An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values. 324 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 325 "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. 326 "A String", 327 ], 328 }, 329 ], 330 "userId": "A String", # Required. User's UUID provided by the client. 331}</pre> 332</div> 333 334</body></html>