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.consents.html">consents</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the specified Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified consent is in the `REJECTED` or `REVOKED` state.</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 Consent 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 Consent and its revisions. To keep a record of the Consent but mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [DeleteConsentRevision]. This operation does not delete the related Consent artifact.</p> 89<p class="toc_element"> 90 <code><a href="#deleteRevision">deleteRevision(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Gets the specified revision of a Consent, or the latest revision if `revision_id` is not specified in the resource name.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists the Consent in the given consent store, returning each Consent's latest revision.</p> 98<p class="toc_element"> 99 <code><a href="#listRevisions">listRevisions(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Lists the revisions of the specified Consent in reverse chronological order.</p> 101<p class="toc_element"> 102 <code><a href="#listRevisions_next">listRevisions_next(previous_request, previous_response)</a></code></p> 103<p class="firstline">Retrieves the next page of results.</p> 104<p class="toc_element"> 105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 106<p class="firstline">Retrieves the next page of results.</p> 107<p class="toc_element"> 108 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `REJECTED` or `REVOKED` state.</p> 110<p class="toc_element"> 111 <code><a href="#reject">reject(name, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the specified Consent is in the `REJECTED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `ACTIVE` or `REVOKED` state.</p> 113<p class="toc_element"> 114 <code><a href="#revoke">revoke(name, body=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the specified Consent is in the `REVOKED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in `DRAFT` or `REJECTED` state.</p> 116<h3>Method Details</h3> 117<div class="method"> 118 <code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code> 119 <pre>Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the specified Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified consent is in the `REJECTED` or `REVOKED` state. 120 121Args: 122 name: string, Required. The resource name of the Consent to activate, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name. (required) 123 body: object, The request body. 124 The object takes the form of: 125 126{ # Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the given Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in the `REJECTED` or `REVOKED` state. 127 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains documentation of the user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. If the draft Consent had a Consent artifact, this Consent artifact overwrites it. 128 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 129 "ttl": "A String", # The time to live for this Consent from when it is marked as active. 130} 131 132 x__xgafv: string, V1 error format. 133 Allowed values 134 1 - v1 error format 135 2 - v2 error format 136 137Returns: 138 An object of the form: 139 140 { # Represents a user's consent. 141 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 142 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 143 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 144 "a_key": "A String", 145 }, 146 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 147 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 148 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 149 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 150 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 151 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 152 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 153 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 154 }, 155 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 156 { # 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. 157 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 158 "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. 159 "A String", 160 ], 161 }, 162 ], 163 }, 164 ], 165 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 166 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 167 "state": "A String", # Required. Indicates the current state of this Consent. 168 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 169 "userId": "A String", # Required. User's UUID provided by the client. 170}</pre> 171</div> 172 173<div class="method"> 174 <code class="details" id="close">close()</code> 175 <pre>Close httplib2 connections.</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 180 <pre>Creates a new Consent in the parent consent store. 181 182Args: 183 parent: string, Required. Name of the consent store. (required) 184 body: object, The request body. 185 The object takes the form of: 186 187{ # Represents a user's consent. 188 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 189 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 190 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 191 "a_key": "A String", 192 }, 193 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 194 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 195 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 196 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 197 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 198 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 199 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 200 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 201 }, 202 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 203 { # 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. 204 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 205 "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. 206 "A String", 207 ], 208 }, 209 ], 210 }, 211 ], 212 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 213 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 214 "state": "A String", # Required. Indicates the current state of this Consent. 215 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 216 "userId": "A String", # Required. User's UUID provided by the client. 217} 218 219 x__xgafv: string, V1 error format. 220 Allowed values 221 1 - v1 error format 222 2 - v2 error format 223 224Returns: 225 An object of the form: 226 227 { # Represents a user's consent. 228 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 229 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 230 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 231 "a_key": "A String", 232 }, 233 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 234 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 235 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 236 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 237 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 238 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 239 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 240 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 241 }, 242 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 243 { # 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. 244 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 245 "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. 246 "A String", 247 ], 248 }, 249 ], 250 }, 251 ], 252 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 253 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 254 "state": "A String", # Required. Indicates the current state of this Consent. 255 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 256 "userId": "A String", # Required. User's UUID provided by the client. 257}</pre> 258</div> 259 260<div class="method"> 261 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 262 <pre>Deletes the Consent and its revisions. To keep a record of the Consent but mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [DeleteConsentRevision]. This operation does not delete the related Consent artifact. 263 264Args: 265 name: string, Required. The resource name of the Consent to delete, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name. (required) 266 x__xgafv: string, V1 error format. 267 Allowed values 268 1 - v1 error format 269 2 - v2 error format 270 271Returns: 272 An object of the form: 273 274 { # 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 `{}`. 275}</pre> 276</div> 277 278<div class="method"> 279 <code class="details" id="deleteRevision">deleteRevision(name, x__xgafv=None)</code> 280 <pre>Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision. 281 282Args: 283 name: string, Required. The resource name of the Consent revision to delete, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}@{revision_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name. (required) 284 x__xgafv: string, V1 error format. 285 Allowed values 286 1 - v1 error format 287 2 - v2 error format 288 289Returns: 290 An object of the form: 291 292 { # 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 `{}`. 293}</pre> 294</div> 295 296<div class="method"> 297 <code class="details" id="get">get(name, x__xgafv=None)</code> 298 <pre>Gets the specified revision of a Consent, or the latest revision if `revision_id` is not specified in the resource name. 299 300Args: 301 name: string, Required. The resource name of the Consent to retrieve, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. In order to retrieve a previous revision of the Consent, also provide the revision ID: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}@{revision_id}` (required) 302 x__xgafv: string, V1 error format. 303 Allowed values 304 1 - v1 error format 305 2 - v2 error format 306 307Returns: 308 An object of the form: 309 310 { # Represents a user's consent. 311 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 312 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 313 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 314 "a_key": "A String", 315 }, 316 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 317 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 318 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 319 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 320 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 321 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 322 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 323 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 324 }, 325 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 326 { # 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. 327 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 328 "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. 329 "A String", 330 ], 331 }, 332 ], 333 }, 334 ], 335 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 336 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 337 "state": "A String", # Required. Indicates the current state of this Consent. 338 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 339 "userId": "A String", # Required. User's UUID provided by the client. 340}</pre> 341</div> 342 343<div class="method"> 344 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 345 <pre>Lists the Consent in the given consent store, returning each Consent's latest revision. 346 347Args: 348 parent: string, Required. Name of the consent store to retrieve Consents from. (required) 349 filter: string, Optional. Restricts the consents 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: - user_id. For example, `filter='user_id="user123"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`. 350 pageSize: integer, Optional. Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000. 351 pageToken: string, Optional. The next_page_token value returned from the previous List request, if any. 352 x__xgafv: string, V1 error format. 353 Allowed values 354 1 - v1 error format 355 2 - v2 error format 356 357Returns: 358 An object of the form: 359 360 { 361 "consents": [ # The returned Consents. The maximum number of Consents returned is determined by the value of page_size in the ListConsentsRequest. 362 { # Represents a user's consent. 363 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 364 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 365 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 366 "a_key": "A String", 367 }, 368 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 369 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 370 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 371 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 372 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 373 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 374 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 375 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 376 }, 377 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 378 { # 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. 379 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 380 "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. 381 "A String", 382 ], 383 }, 384 ], 385 }, 386 ], 387 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 388 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 389 "state": "A String", # Required. Indicates the current state of this Consent. 390 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 391 "userId": "A String", # Required. User's UUID provided by the client. 392 }, 393 ], 394 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 395}</pre> 396</div> 397 398<div class="method"> 399 <code class="details" id="listRevisions">listRevisions(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 400 <pre>Lists the revisions of the specified Consent in reverse chronological order. 401 402Args: 403 name: string, Required. The resource name of the Consent to retrieve revisions for. (required) 404 filter: string, Optional. Restricts the revisions 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. Fields/functions available for filtering are: - user_id. For example, `filter='user_id="user123"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`. 405 pageSize: integer, Optional. Limit on the number of revisions to return in a single response. If not specified, 100 is used. May not be larger than 1000. 406 pageToken: string, Optional. Token to retrieve the next page of results or empty if there are no more results in the list. 407 x__xgafv: string, V1 error format. 408 Allowed values 409 1 - v1 error format 410 2 - v2 error format 411 412Returns: 413 An object of the form: 414 415 { 416 "consents": [ # The returned Consent revisions. The maximum number of revisions returned is determined by the value of `page_size` in the ListConsentRevisionsRequest. 417 { # Represents a user's consent. 418 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 419 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 420 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 421 "a_key": "A String", 422 }, 423 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 424 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 425 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 426 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 427 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 428 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 429 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 430 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 431 }, 432 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 433 { # 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. 434 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 435 "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. 436 "A String", 437 ], 438 }, 439 ], 440 }, 441 ], 442 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 443 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 444 "state": "A String", # Required. Indicates the current state of this Consent. 445 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 446 "userId": "A String", # Required. User's UUID provided by the client. 447 }, 448 ], 449 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 450}</pre> 451</div> 452 453<div class="method"> 454 <code class="details" id="listRevisions_next">listRevisions_next(previous_request, previous_response)</code> 455 <pre>Retrieves the next page of results. 456 457Args: 458 previous_request: The request for the previous page. (required) 459 previous_response: The response from the request for the previous page. (required) 460 461Returns: 462 A request object that you can call 'execute()' on to request the next 463 page. Returns None if there are no more items in the collection. 464 </pre> 465</div> 466 467<div class="method"> 468 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 469 <pre>Retrieves the next page of results. 470 471Args: 472 previous_request: The request for the previous page. (required) 473 previous_response: The response from the request for the previous page. (required) 474 475Returns: 476 A request object that you can call 'execute()' on to request the next 477 page. Returns None if there are no more items in the collection. 478 </pre> 479</div> 480 481<div class="method"> 482 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 483 <pre>Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `REJECTED` or `REVOKED` state. 484 485Args: 486 name: string, Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. (required) 487 body: object, The request body. 488 The object takes the form of: 489 490{ # Represents a user's consent. 491 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 492 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 493 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 494 "a_key": "A String", 495 }, 496 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 497 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 498 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 499 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 500 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 501 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 502 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 503 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 504 }, 505 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 506 { # 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. 507 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 508 "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. 509 "A String", 510 ], 511 }, 512 ], 513 }, 514 ], 515 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 516 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 517 "state": "A String", # Required. Indicates the current state of this Consent. 518 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 519 "userId": "A String", # Required. User's UUID provided by the client. 520} 521 522 updateMask: string, Required. The update mask to apply to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `user_id`, `policies`, `consent_artifact`, and `metadata` fields can be updated. 523 x__xgafv: string, V1 error format. 524 Allowed values 525 1 - v1 error format 526 2 - v2 error format 527 528Returns: 529 An object of the form: 530 531 { # Represents a user's consent. 532 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 533 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 534 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 535 "a_key": "A String", 536 }, 537 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 538 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 539 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 540 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 541 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 542 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 543 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 544 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 545 }, 546 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 547 { # 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. 548 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 549 "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. 550 "A String", 551 ], 552 }, 553 ], 554 }, 555 ], 556 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 557 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 558 "state": "A String", # Required. Indicates the current state of this Consent. 559 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 560 "userId": "A String", # Required. User's UUID provided by the client. 561}</pre> 562</div> 563 564<div class="method"> 565 <code class="details" id="reject">reject(name, body=None, x__xgafv=None)</code> 566 <pre>Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the specified Consent is in the `REJECTED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `ACTIVE` or `REVOKED` state. 567 568Args: 569 name: string, Required. The resource name of the Consent to reject, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name. (required) 570 body: object, The request body. 571 The object takes the form of: 572 573{ # Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the given Consent is in the `REJECTED` state, no new revision is committed. 574 "consentArtifact": "A String", # Optional. The resource name of the Consent artifact that contains documentation of the user's rejection of the draft Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. If the draft Consent had a Consent artifact, this Consent artifact overwrites it. 575} 576 577 x__xgafv: string, V1 error format. 578 Allowed values 579 1 - v1 error format 580 2 - v2 error format 581 582Returns: 583 An object of the form: 584 585 { # Represents a user's consent. 586 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 587 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 588 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 589 "a_key": "A String", 590 }, 591 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 592 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 593 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 594 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 595 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 596 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 597 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 598 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 599 }, 600 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 601 { # 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. 602 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 603 "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. 604 "A String", 605 ], 606 }, 607 ], 608 }, 609 ], 610 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 611 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 612 "state": "A String", # Required. Indicates the current state of this Consent. 613 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 614 "userId": "A String", # Required. User's UUID provided by the client. 615}</pre> 616</div> 617 618<div class="method"> 619 <code class="details" id="revoke">revoke(name, body=None, x__xgafv=None)</code> 620 <pre>Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the specified Consent is in the `REVOKED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in `DRAFT` or `REJECTED` state. 621 622Args: 623 name: string, Required. The resource name of the Consent to revoke, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name. (required) 624 body: object, The request body. 625 The object takes the form of: 626 627{ # Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the given Consent is in the `REVOKED` state, no new revision is committed. 628 "consentArtifact": "A String", # Optional. The resource name of the Consent artifact that contains proof of the user's revocation of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 629} 630 631 x__xgafv: string, V1 error format. 632 Allowed values 633 1 - v1 error format 634 2 - v2 error format 635 636Returns: 637 An object of the form: 638 639 { # Represents a user's consent. 640 "consentArtifact": "A String", # Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. 641 "expireTime": "A String", # Timestamp in UTC of when this Consent is considered expired. 642 "metadata": { # Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. 643 "a_key": "A String", 644 }, 645 "name": "A String", # Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. 646 "policies": [ # Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. 647 { # Represents a user's consent in terms of the resources that can be accessed and under what conditions. 648 "authorizationRule": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). 649 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 650 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 651 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 652 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 653 }, 654 "resourceAttributes": [ # The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. 655 { # 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. 656 "attributeDefinitionId": "A String", # Indicates the name of an attribute defined in the consent store. 657 "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. 658 "A String", 659 ], 660 }, 661 ], 662 }, 663 ], 664 "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. 665 "revisionId": "A String", # Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. 666 "state": "A String", # Required. Indicates the current state of this Consent. 667 "ttl": "A String", # Input only. The time to live for this Consent from when it is created. 668 "userId": "A String", # Required. User's UUID provided by the client. 669}</pre> 670</div> 671 672</body></html>