Class ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource

The "consents" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource

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.v1

Assembly: Google.Apis.CloudHealthcare.v1.dll

Syntax

public class ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource

Constructors

ConsentsResource(IClientService)

Constructs a new resource.

Declaration

public ConsentsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Activate(ActivateConsentRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.ActivateRequest Activate(ActivateConsentRequest body, string name)

Parameters

Type	Name	Description
ActivateConsentRequest	body	The body of the request.
string	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.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.ActivateRequest

Create(Consent, string)

Creates a new Consent in the parent consent store.

Declaration

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

Parameters

Type	Name	Description
Consent	body	The body of the request.
string	parent	Required. Name of the consent store.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.CreateRequest

Delete(string)

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.

Declaration

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

Parameters

Type	Name	Description
string	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

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.DeleteRequest

DeleteRevision(string)

Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.DeleteRevisionRequest DeleteRevision(string name)

Parameters

Type	Name	Description
string	name	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.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.DeleteRevisionRequest

Get(string)

Gets the specified revision of a Consent, or the latest revision if revision_id is not specified in the resource name.

Declaration

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

Parameters

Type	Name	Description
string	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/{consent_store_id}/consents/{consent_id}@{revision_id}

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.GetRequest

List(string)

Lists the Consent in the given consent store, returning each Consent's latest revision.

Declaration

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

Parameters

Type	Name	Description
string	parent	Required. Name of the consent store to retrieve Consents from.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.ListRequest

ListRevisions(string)

Lists the revisions of the specified Consent in reverse chronological order.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.ListRevisionsRequest ListRevisions(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the Consent to retrieve revisions for.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.ListRevisionsRequest

Patch(Consent, string)

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.

Declaration

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

Parameters

Type	Name	Description
Consent	body	The body of the request.
string	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.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.PatchRequest

Reject(RejectConsentRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.RejectRequest Reject(RejectConsentRequest body, string name)

Parameters

Type	Name	Description
RejectConsentRequest	body	The body of the request.
string	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.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.RejectRequest

Revoke(RevokeConsentRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.RevokeRequest Revoke(RevokeConsentRequest body, string name)

Parameters

Type	Name	Description
RevokeConsentRequest	body	The body of the request.
string	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.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.RevokeRequest