com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents

java.lang.Object

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

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.ConsentStores

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

The "consents" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Activate
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Create
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Delete
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.DeleteRevision
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Get
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.ListRevisions
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Patch
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Reject
class	CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Revoke

Constructor Summary

Constructors

Constructor and Description
Consents()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Activate	activate(String name, ActivateConsentRequest content) Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Create	create(String parent, Consent content) Creates a new Consent in the parent consent store.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Delete	delete(String name) Deletes the Consent and its revisions.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.DeleteRevision	deleteRevision(String name) Deletes the specified revision of a Consent.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Get	get(String name) Gets the specified revision of a Consent, or the latest revision if `revision_id` is not specified in the resource name.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List	list(String parent) Lists the Consent in the given consent store, returning each Consent's latest revision.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.ListRevisions	listRevisions(String name) Lists the revisions of the specified Consent in reverse chronological order.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Patch	patch(String name, Consent content) Updates the latest revision of the specified Consent by committing a new revision with the changes.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Reject	reject(String name, RejectConsentRequest content) Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`.
CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Revoke	revoke(String name, RevokeConsentRequest content) Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`.

Methods inherited from class java.lang.Object

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

Constructor Detail

Consents

public Consents()

Method Detail

activate

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Activate activate(String name,
                                                                                            ActivateConsentRequest content)
                                                                                     throws IOException

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. Create a request for the method "consents.activate". 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 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.

content - the ActivateConsentRequest

Returns:

the request

Throws:

IOException

create

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

Creates a new Consent in the parent consent store. Create a request for the method "consents.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. Name of the consent store.

content - the Consent

Returns:

the request

Throws:

IOException

delete

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

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. Create a request for the method "consents.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 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.

Returns:

the request

Throws:

IOException

deleteRevision

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.DeleteRevision deleteRevision(String name)
                                                                                                 throws IOException

Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision. Create a request for the method "consents.deleteRevision". 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 revision to delete, of the form `projects/{project_id}/lo cations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{con sent_id}@{revision_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name.

Returns:

the request

Throws:

IOException

get

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

Gets the specified revision of a Consent, or the latest revision if `revision_id` is not specified in the resource name. Create a request for the method "consents.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 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/{consen t_store_id}/consents/{consent_id}@{revision_id}`

Returns:

the request

Throws:

IOException

list

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

Lists the Consent in the given consent store, returning each Consent's latest revision. Create a request for the method "consents.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 consent store to retrieve Consents from.

Returns:

the request

Throws:

IOException

listRevisions

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.ListRevisions listRevisions(String name)
                                                                                               throws IOException

Lists the revisions of the specified Consent in reverse chronological order. Create a request for the method "consents.listRevisions". 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 to retrieve revisions for.

Returns:

the request

Throws:

IOException

patch

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

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. Create a request for the method "consents.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 - Identifier. 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.

content - the Consent

Returns:

the request

Throws:

IOException

reject

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Reject reject(String name,
                                                                                        RejectConsentRequest content)
                                                                                 throws IOException

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. Create a request for the method "consents.reject". 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 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.

content - the RejectConsentRequest

Returns:

the request

Throws:

IOException

revoke

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.Revoke revoke(String name,
                                                                                        RevokeConsentRequest content)
                                                                                 throws IOException

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. Create a request for the method "consents.revoke". 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 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.

content - the RevokeConsentRequest

Returns:

the request

Throws:

IOException