Class ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource

The "consentStores" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudHealthcare.v1beta1

Assembly: Google.Apis.CloudHealthcare.v1beta1.dll

Syntax

public class ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource

Constructors

ConsentStoresResource(IClientService)

Constructs a new resource.

Declaration

public ConsentStoresResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

AttributeDefinitions

Gets the AttributeDefinitions resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.AttributeDefinitionsResource AttributeDefinitions { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.AttributeDefinitionsResource

ConsentArtifacts

Gets the ConsentArtifacts resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentArtifactsResource ConsentArtifacts { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentArtifactsResource

Consents

Gets the Consents resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource Consents { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource

UserDataMappings

Gets the UserDataMappings resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource UserDataMappings { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource

Methods

CheckDataAccess(CheckDataAccessRequest, string)

Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.CheckDataAccessRequest CheckDataAccess(CheckDataAccessRequest body, string consentStore)

Parameters

Type	Name	Description
CheckDataAccessRequest	body	The body of the request.
string	consentStore	Required. Name of the consent store where the requested data_id is stored, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.CheckDataAccessRequest

Create(ConsentStore, string)

Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.CreateRequest Create(ConsentStore body, string parent)

Parameters

Type	Name	Description
ConsentStore	body	The body of the request.
string	parent	Required. The name of the dataset this consent store belongs to.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.CreateRequest

Delete(string)

Deletes the specified consent store and removes all the consent store's data.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the consent store to delete.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.DeleteRequest

EvaluateUserConsents(EvaluateUserConsentsRequest, string)

Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.EvaluateUserConsentsRequest EvaluateUserConsents(EvaluateUserConsentsRequest body, string consentStore)

Parameters

Type	Name	Description
EvaluateUserConsentsRequest	body	The body of the request.
string	consentStore	Required. Name of the consent store to retrieve User data mappings from.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.EvaluateUserConsentsRequest

Get(string)

Gets the specified consent store.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the consent store to get.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

Type	Name	Description
string	resource	REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.GetIamPolicyRequest

List(string)

Lists the consent stores in the specified dataset.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. Name of the dataset.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ListRequest

Patch(ConsentStore, string)

Updates the specified consent store.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.PatchRequest Patch(ConsentStore body, string name)

Parameters

Type	Name	Description
ConsentStore	body	The body of the request.
string	name	Resource name of the consent store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. Cannot be changed after creation.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.PatchRequest

QueryAccessibleData(QueryAccessibleDataRequest, string)

Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). For example, the following sample log entry shows a failed to evaluate consent policy error that occurred during a QueryAccessibleData call to consent store projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}.

json jsonPayload: { @type:
"type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code:
9 message: "failed to evaluate consent policy" } resourceName:
"projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}"
} logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data"
operation: { id:
"projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{operation_id}"
producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP"
resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}"
location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" }
severity: "ERROR" timestamp: "TIMESTAMP"

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.QueryAccessibleDataRequest QueryAccessibleData(QueryAccessibleDataRequest body, string consentStore)

Parameters

Type	Name	Description
QueryAccessibleDataRequest	body	The body of the request.
string	consentStore	Required. Name of the consent store to retrieve User data mappings from.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.QueryAccessibleDataRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.TestIamPermissionsRequest