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_v1.html">Cloud Healthcare API</a> . <a href="healthcare_v1.projects.html">projects</a> . <a href="healthcare_v1.projects.locations.html">locations</a> . <a href="healthcare_v1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1.projects.locations.datasets.consentStores.html">consentStores</a> . <a href="healthcare_v1.projects.locations.datasets.consentStores.attributeDefinitions.html">attributeDefinitions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, attributeDefinitionId=None, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new Attribute definition in the parent consent store.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the specified Attribute definition.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the Attribute definitions in the specified consent store.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates the specified Attribute definition.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, attributeDefinitionId=None, body=None, x__xgafv=None)</code> 106 <pre>Creates a new Attribute definition in the parent consent store. 107 108Args: 109 parent: string, Required. The name of the consent store that this Attribute definition belongs to. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # A client-defined consent attribute. 114 "allowedValues": [ # Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. 115 "A String", 116 ], 117 "category": "A String", # Required. The category of the attribute. The value of this field cannot be changed after creation. 118 "consentDefaultValues": [ # Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. 119 "A String", 120 ], 121 "dataMappingDefaultValue": "A String", # Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. 122 "description": "A String", # Optional. A description of the attribute. 123 "name": "A String", # Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. 124} 125 126 attributeDefinitionId: string, Required. The ID of the Attribute definition to create. The string must match the following regex: `_a-zA-Z{0,255}` and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md. 127 x__xgafv: string, V1 error format. 128 Allowed values 129 1 - v1 error format 130 2 - v2 error format 131 132Returns: 133 An object of the form: 134 135 { # A client-defined consent attribute. 136 "allowedValues": [ # Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. 137 "A String", 138 ], 139 "category": "A String", # Required. The category of the attribute. The value of this field cannot be changed after creation. 140 "consentDefaultValues": [ # Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. 141 "A String", 142 ], 143 "dataMappingDefaultValue": "A String", # Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. 144 "description": "A String", # Optional. A description of the attribute. 145 "name": "A String", # Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. 146}</pre> 147</div> 148 149<div class="method"> 150 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 151 <pre>Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent. 152 153Args: 154 name: string, Required. The resource name of the Attribute definition to delete. To preserve referential integrity, Attribute definitions referenced by a User data mapping or the latest revision of a Consent cannot be deleted. (required) 155 x__xgafv: string, V1 error format. 156 Allowed values 157 1 - v1 error format 158 2 - v2 error format 159 160Returns: 161 An object of the form: 162 163 { # 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 `{}`. 164}</pre> 165</div> 166 167<div class="method"> 168 <code class="details" id="get">get(name, x__xgafv=None)</code> 169 <pre>Gets the specified Attribute definition. 170 171Args: 172 name: string, Required. The resource name of the Attribute definition to get. (required) 173 x__xgafv: string, V1 error format. 174 Allowed values 175 1 - v1 error format 176 2 - v2 error format 177 178Returns: 179 An object of the form: 180 181 { # A client-defined consent attribute. 182 "allowedValues": [ # Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. 183 "A String", 184 ], 185 "category": "A String", # Required. The category of the attribute. The value of this field cannot be changed after creation. 186 "consentDefaultValues": [ # Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. 187 "A String", 188 ], 189 "dataMappingDefaultValue": "A String", # Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. 190 "description": "A String", # Optional. A description of the attribute. 191 "name": "A String", # Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. 192}</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 197 <pre>Lists the Attribute definitions in the specified consent store. 198 199Args: 200 parent: string, Required. Name of the consent store to retrieve Attribute definitions from. (required) 201 filter: string, Optional. Restricts the attributes returned to those matching a filter. The only field available for filtering is `category`. For example, `filter=category=\"REQUEST\"`. 202 pageSize: integer, Optional. Limit on the number of Attribute definitions to return in a single response. If not specified, 100 is used. May not be larger than 1000. 203 pageToken: string, Optional. Token to retrieve the next page of results or empty to get the first page. 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { 213 "attributeDefinitions": [ # The returned Attribute definitions. The maximum number of attributes returned is determined by the value of page_size in the ListAttributeDefinitionsRequest. 214 { # A client-defined consent attribute. 215 "allowedValues": [ # Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. 216 "A String", 217 ], 218 "category": "A String", # Required. The category of the attribute. The value of this field cannot be changed after creation. 219 "consentDefaultValues": [ # Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. 220 "A String", 221 ], 222 "dataMappingDefaultValue": "A String", # Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. 223 "description": "A String", # Optional. A description of the attribute. 224 "name": "A String", # Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. 225 }, 226 ], 227 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 233 <pre>Retrieves the next page of results. 234 235Args: 236 previous_request: The request for the previous page. (required) 237 previous_response: The response from the request for the previous page. (required) 238 239Returns: 240 A request object that you can call 'execute()' on to request the next 241 page. Returns None if there are no more items in the collection. 242 </pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 247 <pre>Updates the specified Attribute definition. 248 249Args: 250 name: string, Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. (required) 251 body: object, The request body. 252 The object takes the form of: 253 254{ # A client-defined consent attribute. 255 "allowedValues": [ # Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. 256 "A String", 257 ], 258 "category": "A String", # Required. The category of the attribute. The value of this field cannot be changed after creation. 259 "consentDefaultValues": [ # Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. 260 "A String", 261 ], 262 "dataMappingDefaultValue": "A String", # Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. 263 "description": "A String", # Optional. A description of the attribute. 264 "name": "A String", # Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. 265} 266 267 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 `description`, `allowed_values`, `consent_default_values` and `data_mapping_default_value` fields can be updated. The updated `allowed_values` must contain all values from the previous `allowed_values`. 268 x__xgafv: string, V1 error format. 269 Allowed values 270 1 - v1 error format 271 2 - v2 error format 272 273Returns: 274 An object of the form: 275 276 { # A client-defined consent attribute. 277 "allowedValues": [ # Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. 278 "A String", 279 ], 280 "category": "A String", # Required. The category of the attribute. The value of this field cannot be changed after creation. 281 "consentDefaultValues": [ # Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. 282 "A String", 283 ], 284 "dataMappingDefaultValue": "A String", # Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. 285 "description": "A String", # Optional. A description of the attribute. 286 "name": "A String", # Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. 287}</pre> 288</div> 289 290</body></html>