com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.ConsentStores

java.lang.Object

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.ConsentStores

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets

public class CloudHealthcare.Projects.Locations.Datasets.ConsentStores
extends Object

The "consentStores" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.AttributeDefinitions The "attributeDefinitions" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.CheckDataAccess
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.ConsentArtifacts The "consentArtifacts" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents The "consents" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Create
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Delete
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.EvaluateUserConsents
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Get
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.GetIamPolicy
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.List
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Patch
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.SetIamPolicy
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.TestIamPermissions
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.UserDataMappings The "userDataMappings" collection of methods.

Constructor Summary

Constructors

Constructor and Description
ConsentStores()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.AttributeDefinitions	attributeDefinitions() An accessor for creating requests from the AttributeDefinitions collection.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.CheckDataAccess	checkDataAccess(String consentStore, CheckDataAccessRequest content) Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.ConsentArtifacts	consentArtifacts() An accessor for creating requests from the ConsentArtifacts collection.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents	consents() An accessor for creating requests from the Consents collection.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Create	create(String parent, ConsentStore content) Creates a new consent store in the parent dataset.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Delete	delete(String name) Deletes the specified consent store and removes all the consent store's data.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.EvaluateUserConsents	evaluateUserConsents(String consentStore, EvaluateUserConsentsRequest content) Evaluates the user's Consents for all matching User data mappings.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Get	get(String name) Gets the specified consent store.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.List	list(String parent) Lists the consent stores in the specified dataset.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Patch	patch(String name, ConsentStore content) Updates the specified consent store.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData	queryAccessibleData(String consentStore, QueryAccessibleDataRequest content) Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.UserDataMappings	userDataMappings() An accessor for creating requests from the UserDataMappings collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsentStores

public ConsentStores()

Method Detail

checkDataAccess

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.CheckDataAccess checkDataAccess(String consentStore,
                                                                                                 CheckDataAccessRequest content)
                                                                                          throws IOException

Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use. Create a request for the method "consentStores.checkDataAccess". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

consentStore - Required. Name of the consent store where the requested data_id is stored, of the form `projects/{pr oject_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`.

content - the CheckDataAccessRequest

Returns:

the request

Throws:

IOException

create

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Create create(String parent,
                                                                               ConsentStore content)
                                                                        throws IOException

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. Create a request for the method "consentStores.create". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the dataset this consent store belongs to.

content - the ConsentStore

Returns:

the request

Throws:

IOException

delete

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Delete delete(String name)
                                                                        throws IOException

Deletes the specified consent store and removes all the consent store's data. Create a request for the method "consentStores.delete". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the consent store to delete.

Returns:

the request

Throws:

IOException

evaluateUserConsents

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.EvaluateUserConsents evaluateUserConsents(String consentStore,
                                                                                                           EvaluateUserConsentsRequest content)
                                                                                                    throws IOException

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. Create a request for the method "consentStores.evaluateUserConsents". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

consentStore - Required. Name of the consent store to retrieve User data mappings from.

content - the EvaluateUserConsentsRequest

Returns:

the request

Throws:

IOException

get

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Get get(String name)
                                                                  throws IOException

Gets the specified consent store. Create a request for the method "consentStores.get". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the consent store to get.

Returns:

the request

Throws:

IOException

getIamPolicy

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.GetIamPolicy getIamPolicy(String resource)
                                                                                    throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "consentStores.getIamPolicy". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

list

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.List list(String parent)
                                                                    throws IOException

Lists the consent stores in the specified dataset. Create a request for the method "consentStores.list". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the dataset.

Returns:

the request

Throws:

IOException

patch

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Patch patch(String name,
                                                                             ConsentStore content)
                                                                      throws IOException

Updates the specified consent store. Create a request for the method "consentStores.patch". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datas ets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation.

content - the ConsentStore

Returns:

the request

Throws:

IOException

queryAccessibleData

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData queryAccessibleData(String consentStore,
                                                                                                         QueryAccessibleDataRequest content)
                                                                                                  throws IOException

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](https://cloud.google.com/healthcare/docs/how-tos/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: {

Parameters:

consentStore - Required. Name of the consent store to retrieve User data mappings from.

content - the QueryAccessibleDataRequest

Returns:

the request

Throws:

IOException

setIamPolicy

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.SetIamPolicy setIamPolicy(String resource,
                                                                                           SetIamPolicyRequest content)
                                                                                    throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "consentStores.setIamPolicy". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.TestIamPermissions testIamPermissions(String resource,
                                                                                                       TestIamPermissionsRequest content)
                                                                                                throws IOException

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. Create a request for the method "consentStores.testIamPermissions". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

attributeDefinitions

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.AttributeDefinitions attributeDefinitions()

An accessor for creating requests from the AttributeDefinitions collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.AttributeDefinitions.List request = healthcare.attributeDefinitions().list(parameters ...)
 

Returns:

the resource collection

consentArtifacts

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.ConsentArtifacts consentArtifacts()

An accessor for creating requests from the ConsentArtifacts collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.ConsentArtifacts.List request = healthcare.consentArtifacts().list(parameters ...)
 

Returns:

the resource collection

consents

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents consents()

An accessor for creating requests from the Consents collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.Consents.List request = healthcare.consents().list(parameters ...)
 

Returns:

the resource collection

userDataMappings

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.UserDataMappings userDataMappings()

An accessor for creating requests from the UserDataMappings collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.UserDataMappings.List request = healthcare.userDataMappings().list(parameters ...)
 

Returns:

the resource collection