Struct google_healthcare1_beta1::api::ProjectMethods
source · pub struct ProjectMethods<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
A builder providing access to all methods supported on project resources.
It is not used directly, but through the CloudHealthcare
hub.
§Example
Instantiate a resource builder
extern crate hyper;
extern crate hyper_rustls;
extern crate google_healthcare1_beta1 as healthcare1_beta1;
use std::default::Default;
use healthcare1_beta1::{CloudHealthcare, oauth2, hyper, hyper_rustls, chrono, FieldMask};
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = CloudHealthcare::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `locations_datasets_annotation_stores_annotations_create(...)`, `locations_datasets_annotation_stores_annotations_delete(...)`, `locations_datasets_annotation_stores_annotations_get(...)`, `locations_datasets_annotation_stores_annotations_list(...)`, `locations_datasets_annotation_stores_annotations_patch(...)`, `locations_datasets_annotation_stores_create(...)`, `locations_datasets_annotation_stores_delete(...)`, `locations_datasets_annotation_stores_evaluate(...)`, `locations_datasets_annotation_stores_export(...)`, `locations_datasets_annotation_stores_get(...)`, `locations_datasets_annotation_stores_get_iam_policy(...)`, `locations_datasets_annotation_stores_import(...)`, `locations_datasets_annotation_stores_list(...)`, `locations_datasets_annotation_stores_patch(...)`, `locations_datasets_annotation_stores_set_iam_policy(...)`, `locations_datasets_annotation_stores_test_iam_permissions(...)`, `locations_datasets_consent_stores_attribute_definitions_create(...)`, `locations_datasets_consent_stores_attribute_definitions_delete(...)`, `locations_datasets_consent_stores_attribute_definitions_get(...)`, `locations_datasets_consent_stores_attribute_definitions_list(...)`, `locations_datasets_consent_stores_attribute_definitions_patch(...)`, `locations_datasets_consent_stores_check_data_access(...)`, `locations_datasets_consent_stores_consent_artifacts_create(...)`, `locations_datasets_consent_stores_consent_artifacts_delete(...)`, `locations_datasets_consent_stores_consent_artifacts_get(...)`, `locations_datasets_consent_stores_consent_artifacts_list(...)`, `locations_datasets_consent_stores_consents_activate(...)`, `locations_datasets_consent_stores_consents_create(...)`, `locations_datasets_consent_stores_consents_delete(...)`, `locations_datasets_consent_stores_consents_delete_revision(...)`, `locations_datasets_consent_stores_consents_get(...)`, `locations_datasets_consent_stores_consents_list(...)`, `locations_datasets_consent_stores_consents_list_revisions(...)`, `locations_datasets_consent_stores_consents_patch(...)`, `locations_datasets_consent_stores_consents_reject(...)`, `locations_datasets_consent_stores_consents_revoke(...)`, `locations_datasets_consent_stores_create(...)`, `locations_datasets_consent_stores_delete(...)`, `locations_datasets_consent_stores_evaluate_user_consents(...)`, `locations_datasets_consent_stores_get(...)`, `locations_datasets_consent_stores_get_iam_policy(...)`, `locations_datasets_consent_stores_list(...)`, `locations_datasets_consent_stores_patch(...)`, `locations_datasets_consent_stores_query_accessible_data(...)`, `locations_datasets_consent_stores_set_iam_policy(...)`, `locations_datasets_consent_stores_test_iam_permissions(...)`, `locations_datasets_consent_stores_user_data_mappings_archive(...)`, `locations_datasets_consent_stores_user_data_mappings_create(...)`, `locations_datasets_consent_stores_user_data_mappings_delete(...)`, `locations_datasets_consent_stores_user_data_mappings_get(...)`, `locations_datasets_consent_stores_user_data_mappings_list(...)`, `locations_datasets_consent_stores_user_data_mappings_patch(...)`, `locations_datasets_create(...)`, `locations_datasets_data_mapper_workspaces_get_iam_policy(...)`, `locations_datasets_data_mapper_workspaces_set_iam_policy(...)`, `locations_datasets_data_mapper_workspaces_test_iam_permissions(...)`, `locations_datasets_deidentify(...)`, `locations_datasets_delete(...)`, `locations_datasets_dicom_stores_create(...)`, `locations_datasets_dicom_stores_deidentify(...)`, `locations_datasets_dicom_stores_delete(...)`, `locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics(...)`, `locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics(...)`, `locations_datasets_dicom_stores_dicom_web_studies_series_instances_get_storage_info(...)`, `locations_datasets_dicom_stores_dicom_web_studies_set_blob_storage_settings(...)`, `locations_datasets_dicom_stores_export(...)`, `locations_datasets_dicom_stores_get(...)`, `locations_datasets_dicom_stores_get_dicom_store_metrics(...)`, `locations_datasets_dicom_stores_get_iam_policy(...)`, `locations_datasets_dicom_stores_import(...)`, `locations_datasets_dicom_stores_list(...)`, `locations_datasets_dicom_stores_patch(...)`, `locations_datasets_dicom_stores_search_for_instances(...)`, `locations_datasets_dicom_stores_search_for_series(...)`, `locations_datasets_dicom_stores_search_for_studies(...)`, `locations_datasets_dicom_stores_set_blob_storage_settings(...)`, `locations_datasets_dicom_stores_set_iam_policy(...)`, `locations_datasets_dicom_stores_store_instances(...)`, `locations_datasets_dicom_stores_studies_delete(...)`, `locations_datasets_dicom_stores_studies_retrieve_metadata(...)`, `locations_datasets_dicom_stores_studies_retrieve_study(...)`, `locations_datasets_dicom_stores_studies_search_for_instances(...)`, `locations_datasets_dicom_stores_studies_search_for_series(...)`, `locations_datasets_dicom_stores_studies_series_delete(...)`, `locations_datasets_dicom_stores_studies_series_instances_bulkdata_retrieve_bulkdata(...)`, `locations_datasets_dicom_stores_studies_series_instances_delete(...)`, `locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames(...)`, `locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered(...)`, `locations_datasets_dicom_stores_studies_series_instances_retrieve_instance(...)`, `locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata(...)`, `locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered(...)`, `locations_datasets_dicom_stores_studies_series_retrieve_metadata(...)`, `locations_datasets_dicom_stores_studies_series_retrieve_series(...)`, `locations_datasets_dicom_stores_studies_series_search_for_instances(...)`, `locations_datasets_dicom_stores_studies_store_instances(...)`, `locations_datasets_dicom_stores_test_iam_permissions(...)`, `locations_datasets_fhir_stores_apply_admin_consents(...)`, `locations_datasets_fhir_stores_apply_consents(...)`, `locations_datasets_fhir_stores_configure_search(...)`, `locations_datasets_fhir_stores_create(...)`, `locations_datasets_fhir_stores_deidentify(...)`, `locations_datasets_fhir_stores_delete(...)`, `locations_datasets_fhir_stores_explain_data_access(...)`, `locations_datasets_fhir_stores_export(...)`, `locations_datasets_fhir_stores_fhir__concept_map_search_translate(...)`, `locations_datasets_fhir_stores_fhir__concept_map_translate(...)`, `locations_datasets_fhir_stores_fhir__consent_enforcement_status(...)`, `locations_datasets_fhir_stores_fhir__observation_lastn(...)`, `locations_datasets_fhir_stores_fhir__patient_consent_enforcement_status(...)`, `locations_datasets_fhir_stores_fhir__patient_everything(...)`, `locations_datasets_fhir_stores_fhir__resource_incoming_references(...)`, `locations_datasets_fhir_stores_fhir__resource_purge(...)`, `locations_datasets_fhir_stores_fhir__resource_validate(...)`, `locations_datasets_fhir_stores_fhir_capabilities(...)`, `locations_datasets_fhir_stores_fhir_conditional_delete(...)`, `locations_datasets_fhir_stores_fhir_conditional_patch(...)`, `locations_datasets_fhir_stores_fhir_conditional_update(...)`, `locations_datasets_fhir_stores_fhir_create(...)`, `locations_datasets_fhir_stores_fhir_delete(...)`, `locations_datasets_fhir_stores_fhir_execute_bundle(...)`, `locations_datasets_fhir_stores_fhir_history(...)`, `locations_datasets_fhir_stores_fhir_patch(...)`, `locations_datasets_fhir_stores_fhir_read(...)`, `locations_datasets_fhir_stores_fhir_search(...)`, `locations_datasets_fhir_stores_fhir_search_type(...)`, `locations_datasets_fhir_stores_fhir_update(...)`, `locations_datasets_fhir_stores_fhir_vread(...)`, `locations_datasets_fhir_stores_get(...)`, `locations_datasets_fhir_stores_get_fhir_store_metrics(...)`, `locations_datasets_fhir_stores_get_iam_policy(...)`, `locations_datasets_fhir_stores_import(...)`, `locations_datasets_fhir_stores_list(...)`, `locations_datasets_fhir_stores_patch(...)`, `locations_datasets_fhir_stores_rollback(...)`, `locations_datasets_fhir_stores_set_iam_policy(...)`, `locations_datasets_fhir_stores_test_iam_permissions(...)`, `locations_datasets_get(...)`, `locations_datasets_get_iam_policy(...)`, `locations_datasets_hl7_v2_stores_create(...)`, `locations_datasets_hl7_v2_stores_delete(...)`, `locations_datasets_hl7_v2_stores_export(...)`, `locations_datasets_hl7_v2_stores_get(...)`, `locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics(...)`, `locations_datasets_hl7_v2_stores_get_iam_policy(...)`, `locations_datasets_hl7_v2_stores_import(...)`, `locations_datasets_hl7_v2_stores_list(...)`, `locations_datasets_hl7_v2_stores_messages_batch_get(...)`, `locations_datasets_hl7_v2_stores_messages_create(...)`, `locations_datasets_hl7_v2_stores_messages_delete(...)`, `locations_datasets_hl7_v2_stores_messages_get(...)`, `locations_datasets_hl7_v2_stores_messages_ingest(...)`, `locations_datasets_hl7_v2_stores_messages_list(...)`, `locations_datasets_hl7_v2_stores_messages_patch(...)`, `locations_datasets_hl7_v2_stores_patch(...)`, `locations_datasets_hl7_v2_stores_set_iam_policy(...)`, `locations_datasets_hl7_v2_stores_test_iam_permissions(...)`, `locations_datasets_list(...)`, `locations_datasets_operations_cancel(...)`, `locations_datasets_operations_get(...)`, `locations_datasets_operations_list(...)`, `locations_datasets_patch(...)`, `locations_datasets_set_iam_policy(...)`, `locations_datasets_test_iam_permissions(...)`, `locations_get(...)`, `locations_list(...)` and `locations_services_nlp_analyze_entities(...)`
// to build up your call.
let rb = hub.projects();
Implementations§
source§impl<'a, S> ProjectMethods<'a, S>
impl<'a, S> ProjectMethods<'a, S>
sourcepub fn locations_datasets_annotation_stores_annotations_create(
&self,
request: Annotation,
parent: &str
) -> ProjectLocationDatasetAnnotationStoreAnnotationCreateCall<'a, S>
pub fn locations_datasets_annotation_stores_annotations_create( &self, request: Annotation, parent: &str ) -> ProjectLocationDatasetAnnotationStoreAnnotationCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.
§Arguments
request
- No description provided.parent
- Required. The name of the Annotation store this annotation belongs to. For example,projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore
.
sourcepub fn locations_datasets_annotation_stores_annotations_delete(
&self,
name: &str
) -> ProjectLocationDatasetAnnotationStoreAnnotationDeleteCall<'a, S>
pub fn locations_datasets_annotation_stores_annotations_delete( &self, name: &str ) -> ProjectLocationDatasetAnnotationStoreAnnotationDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an Annotation or returns NOT_FOUND if it does not exist.
§Arguments
name
- Required. The resource name of the Annotation to delete.
sourcepub fn locations_datasets_annotation_stores_annotations_get(
&self,
name: &str
) -> ProjectLocationDatasetAnnotationStoreAnnotationGetCall<'a, S>
pub fn locations_datasets_annotation_stores_annotations_get( &self, name: &str ) -> ProjectLocationDatasetAnnotationStoreAnnotationGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an Annotation.
§Arguments
name
- Required. The resource name of the Annotation to retrieve.
sourcepub fn locations_datasets_annotation_stores_annotations_list(
&self,
parent: &str
) -> ProjectLocationDatasetAnnotationStoreAnnotationListCall<'a, S>
pub fn locations_datasets_annotation_stores_annotations_list( &self, parent: &str ) -> ProjectLocationDatasetAnnotationStoreAnnotationListCall<'a, S>
Create a builder to help you perform the following task:
Lists the Annotations in the given Annotation store for a source resource.
§Arguments
parent
- Required. Name of the Annotation store to retrieve Annotations from.
sourcepub fn locations_datasets_annotation_stores_annotations_patch(
&self,
request: Annotation,
name: &str
) -> ProjectLocationDatasetAnnotationStoreAnnotationPatchCall<'a, S>
pub fn locations_datasets_annotation_stores_annotations_patch( &self, request: Annotation, name: &str ) -> ProjectLocationDatasetAnnotationStoreAnnotationPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates the Annotation.
§Arguments
request
- No description provided.name
- Identifier. Resource name of the Annotation, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}
.
sourcepub fn locations_datasets_annotation_stores_create(
&self,
request: AnnotationStore,
parent: &str
) -> ProjectLocationDatasetAnnotationStoreCreateCall<'a, S>
pub fn locations_datasets_annotation_stores_create( &self, request: AnnotationStore, parent: &str ) -> ProjectLocationDatasetAnnotationStoreCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new Annotation store within the parent dataset.
§Arguments
request
- No description provided.parent
- Required. The name of the dataset this Annotation store belongs to.
sourcepub fn locations_datasets_annotation_stores_delete(
&self,
name: &str
) -> ProjectLocationDatasetAnnotationStoreDeleteCall<'a, S>
pub fn locations_datasets_annotation_stores_delete( &self, name: &str ) -> ProjectLocationDatasetAnnotationStoreDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified Annotation store and removes all annotations that are contained within it.
§Arguments
name
- Required. The resource name of the Annotation store to delete.
sourcepub fn locations_datasets_annotation_stores_evaluate(
&self,
request: EvaluateAnnotationStoreRequest,
name: &str
) -> ProjectLocationDatasetAnnotationStoreEvaluateCall<'a, S>
pub fn locations_datasets_annotation_stores_evaluate( &self, request: EvaluateAnnotationStoreRequest, name: &str ) -> ProjectLocationDatasetAnnotationStoreEvaluateCall<'a, S>
Create a builder to help you perform the following task:
Evaluate an Annotation store against a ground truth Annotation store. When the operation finishes successfully, a detailed response is returned of type EvaluateAnnotationStoreResponse, contained in the response. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging).
§Arguments
request
- No description provided.name
- Required. The Annotation store to compare againstgolden_store
, in the format ofprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
.
sourcepub fn locations_datasets_annotation_stores_export(
&self,
request: ExportAnnotationsRequest,
name: &str
) -> ProjectLocationDatasetAnnotationStoreExportCall<'a, S>
pub fn locations_datasets_annotation_stores_export( &self, request: ExportAnnotationsRequest, name: &str ) -> ProjectLocationDatasetAnnotationStoreExportCall<'a, S>
Create a builder to help you perform the following task:
Export Annotations from the Annotation store. If the request is successful, a detailed response is returned of type ExportAnnotationsResponse, 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).
§Arguments
request
- No description provided.name
- Required. The name of the Annotation store to export annotations to, in the format ofprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
.
sourcepub fn locations_datasets_annotation_stores_get(
&self,
name: &str
) -> ProjectLocationDatasetAnnotationStoreGetCall<'a, S>
pub fn locations_datasets_annotation_stores_get( &self, name: &str ) -> ProjectLocationDatasetAnnotationStoreGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified Annotation store or returns NOT_FOUND if it does not exist.
§Arguments
name
- Required. The resource name of the Annotation store to get.
sourcepub fn locations_datasets_annotation_stores_get_iam_policy(
&self,
resource: &str
) -> ProjectLocationDatasetAnnotationStoreGetIamPolicyCall<'a, S>
pub fn locations_datasets_annotation_stores_get_iam_policy( &self, resource: &str ) -> ProjectLocationDatasetAnnotationStoreGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
§Arguments
resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_annotation_stores_import(
&self,
request: ImportAnnotationsRequest,
name: &str
) -> ProjectLocationDatasetAnnotationStoreImportCall<'a, S>
pub fn locations_datasets_annotation_stores_import( &self, request: ImportAnnotationsRequest, name: &str ) -> ProjectLocationDatasetAnnotationStoreImportCall<'a, S>
Create a builder to help you perform the following task:
Import Annotations to the Annotation store by loading data from the specified sources. If the request is successful, a detailed response is returned as of type ImportAnnotationsResponse, 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).
§Arguments
request
- No description provided.name
- Required. The name of the Annotation store to which the server imports annotations, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
.
sourcepub fn locations_datasets_annotation_stores_list(
&self,
parent: &str
) -> ProjectLocationDatasetAnnotationStoreListCall<'a, S>
pub fn locations_datasets_annotation_stores_list( &self, parent: &str ) -> ProjectLocationDatasetAnnotationStoreListCall<'a, S>
Create a builder to help you perform the following task:
Lists the Annotation stores in the given dataset for a source store.
§Arguments
parent
- Required. Name of the dataset.
sourcepub fn locations_datasets_annotation_stores_patch(
&self,
request: AnnotationStore,
name: &str
) -> ProjectLocationDatasetAnnotationStorePatchCall<'a, S>
pub fn locations_datasets_annotation_stores_patch( &self, request: AnnotationStore, name: &str ) -> ProjectLocationDatasetAnnotationStorePatchCall<'a, S>
Create a builder to help you perform the following task:
Updates the specified Annotation store.
§Arguments
request
- No description provided.name
- Identifier. Resource name of the Annotation store, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
.
sourcepub fn locations_datasets_annotation_stores_set_iam_policy(
&self,
request: SetIamPolicyRequest,
resource: &str
) -> ProjectLocationDatasetAnnotationStoreSetIamPolicyCall<'a, S>
pub fn locations_datasets_annotation_stores_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationDatasetAnnotationStoreSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_annotation_stores_test_iam_permissions(
&self,
request: TestIamPermissionsRequest,
resource: &str
) -> ProjectLocationDatasetAnnotationStoreTestIamPermissionCall<'a, S>
pub fn locations_datasets_annotation_stores_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationDatasetAnnotationStoreTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_consent_stores_attribute_definitions_create(
&self,
request: AttributeDefinition,
parent: &str
) -> ProjectLocationDatasetConsentStoreAttributeDefinitionCreateCall<'a, S>
pub fn locations_datasets_consent_stores_attribute_definitions_create( &self, request: AttributeDefinition, parent: &str ) -> ProjectLocationDatasetConsentStoreAttributeDefinitionCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new Attribute definition in the parent consent store.
§Arguments
request
- No description provided.parent
- Required. The name of the consent store that this Attribute definition belongs to.
sourcepub fn locations_datasets_consent_stores_attribute_definitions_delete(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreAttributeDefinitionDeleteCall<'a, S>
pub fn locations_datasets_consent_stores_attribute_definitions_delete( &self, name: &str ) -> ProjectLocationDatasetConsentStoreAttributeDefinitionDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.
§Arguments
name
- Required. The resource name of the Attribute definition to delete. To preserve referential integrity, Attribute definitions referenced by a User data mapping or the latest revision of a Consent cannot be deleted.
sourcepub fn locations_datasets_consent_stores_attribute_definitions_get(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreAttributeDefinitionGetCall<'a, S>
pub fn locations_datasets_consent_stores_attribute_definitions_get( &self, name: &str ) -> ProjectLocationDatasetConsentStoreAttributeDefinitionGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified Attribute definition.
§Arguments
name
- Required. The resource name of the Attribute definition to get.
sourcepub fn locations_datasets_consent_stores_attribute_definitions_list(
&self,
parent: &str
) -> ProjectLocationDatasetConsentStoreAttributeDefinitionListCall<'a, S>
pub fn locations_datasets_consent_stores_attribute_definitions_list( &self, parent: &str ) -> ProjectLocationDatasetConsentStoreAttributeDefinitionListCall<'a, S>
Create a builder to help you perform the following task:
Lists the Attribute definitions in the specified consent store.
§Arguments
parent
- Required. Name of the consent store to retrieve Attribute definitions from.
sourcepub fn locations_datasets_consent_stores_attribute_definitions_patch(
&self,
request: AttributeDefinition,
name: &str
) -> ProjectLocationDatasetConsentStoreAttributeDefinitionPatchCall<'a, S>
pub fn locations_datasets_consent_stores_attribute_definitions_patch( &self, request: AttributeDefinition, name: &str ) -> ProjectLocationDatasetConsentStoreAttributeDefinitionPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates the specified Attribute definition.
§Arguments
request
- No description provided.name
- Identifier. Resource name of the Attribute definition, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}
. Cannot be changed after creation.
sourcepub fn locations_datasets_consent_stores_consent_artifacts_create(
&self,
request: ConsentArtifact,
parent: &str
) -> ProjectLocationDatasetConsentStoreConsentArtifactCreateCall<'a, S>
pub fn locations_datasets_consent_stores_consent_artifacts_create( &self, request: ConsentArtifact, parent: &str ) -> ProjectLocationDatasetConsentStoreConsentArtifactCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new Consent artifact in the parent consent store.
§Arguments
request
- No description provided.parent
- Required. The name of the consent store this Consent artifact belongs to.
sourcepub fn locations_datasets_consent_stores_consent_artifacts_delete(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentArtifactDeleteCall<'a, S>
pub fn locations_datasets_consent_stores_consent_artifacts_delete( &self, name: &str ) -> ProjectLocationDatasetConsentStoreConsentArtifactDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.
§Arguments
name
- Required. The resource name of the Consent artifact to delete. To preserve referential integrity, Consent artifacts referenced by the latest revision of a Consent cannot be deleted.
sourcepub fn locations_datasets_consent_stores_consent_artifacts_get(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentArtifactGetCall<'a, S>
pub fn locations_datasets_consent_stores_consent_artifacts_get( &self, name: &str ) -> ProjectLocationDatasetConsentStoreConsentArtifactGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified Consent artifact.
§Arguments
name
- Required. The resource name of the Consent artifact to retrieve.
sourcepub fn locations_datasets_consent_stores_consent_artifacts_list(
&self,
parent: &str
) -> ProjectLocationDatasetConsentStoreConsentArtifactListCall<'a, S>
pub fn locations_datasets_consent_stores_consent_artifacts_list( &self, parent: &str ) -> ProjectLocationDatasetConsentStoreConsentArtifactListCall<'a, S>
Create a builder to help you perform the following task:
Lists the Consent artifacts in the specified consent store.
§Arguments
parent
- Required. Name of the consent store to retrieve consent artifacts from.
sourcepub fn locations_datasets_consent_stores_consents_activate(
&self,
request: ActivateConsentRequest,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentActivateCall<'a, S>
pub fn locations_datasets_consent_stores_consents_activate( &self, request: ActivateConsentRequest, name: &str ) -> ProjectLocationDatasetConsentStoreConsentActivateCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.name
- Required. The resource name of the Consent to activate, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is specified in the name.
sourcepub fn locations_datasets_consent_stores_consents_create(
&self,
request: Consent,
parent: &str
) -> ProjectLocationDatasetConsentStoreConsentCreateCall<'a, S>
pub fn locations_datasets_consent_stores_consents_create( &self, request: Consent, parent: &str ) -> ProjectLocationDatasetConsentStoreConsentCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new Consent in the parent consent store.
§Arguments
request
- No description provided.parent
- Required. Name of the consent store.
sourcepub fn locations_datasets_consent_stores_consents_delete(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentDeleteCall<'a, S>
pub fn locations_datasets_consent_stores_consents_delete( &self, name: &str ) -> ProjectLocationDatasetConsentStoreConsentDeleteCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
name
- Required. The resource name of the Consent to delete, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is specified in the name.
sourcepub fn locations_datasets_consent_stores_consents_delete_revision(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentDeleteRevisionCall<'a, S>
pub fn locations_datasets_consent_stores_consents_delete_revision( &self, name: &str ) -> ProjectLocationDatasetConsentStoreConsentDeleteRevisionCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.
§Arguments
name
- Required. The resource name of the Consent revision to delete, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}@{revision_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is not specified in the name.
sourcepub fn locations_datasets_consent_stores_consents_get(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentGetCall<'a, S>
pub fn locations_datasets_consent_stores_consents_get( &self, name: &str ) -> ProjectLocationDatasetConsentStoreConsentGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified revision of a Consent, or the latest revision if revision_id
is not specified in the resource name.
§Arguments
name
- Required. The resource name of the Consent to retrieve, of the formprojects/{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}
sourcepub fn locations_datasets_consent_stores_consents_list(
&self,
parent: &str
) -> ProjectLocationDatasetConsentStoreConsentListCall<'a, S>
pub fn locations_datasets_consent_stores_consents_list( &self, parent: &str ) -> ProjectLocationDatasetConsentStoreConsentListCall<'a, S>
Create a builder to help you perform the following task:
Lists the Consent in the given consent store, returning each Consent’s latest revision.
§Arguments
parent
- Required. Name of the consent store to retrieve Consents from.
sourcepub fn locations_datasets_consent_stores_consents_list_revisions(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentListRevisionCall<'a, S>
pub fn locations_datasets_consent_stores_consents_list_revisions( &self, name: &str ) -> ProjectLocationDatasetConsentStoreConsentListRevisionCall<'a, S>
Create a builder to help you perform the following task:
Lists the revisions of the specified Consent in reverse chronological order.
§Arguments
name
- Required. The resource name of the Consent to retrieve revisions for.
sourcepub fn locations_datasets_consent_stores_consents_patch(
&self,
request: Consent,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentPatchCall<'a, S>
pub fn locations_datasets_consent_stores_consents_patch( &self, request: Consent, name: &str ) -> ProjectLocationDatasetConsentStoreConsentPatchCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.name
- Identifier. Resource name of the Consent, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. Cannot be changed after creation.
sourcepub fn locations_datasets_consent_stores_consents_reject(
&self,
request: RejectConsentRequest,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentRejectCall<'a, S>
pub fn locations_datasets_consent_stores_consents_reject( &self, request: RejectConsentRequest, name: &str ) -> ProjectLocationDatasetConsentStoreConsentRejectCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.name
- Required. The resource name of the Consent to reject, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is specified in the name.
sourcepub fn locations_datasets_consent_stores_consents_revoke(
&self,
request: RevokeConsentRequest,
name: &str
) -> ProjectLocationDatasetConsentStoreConsentRevokeCall<'a, S>
pub fn locations_datasets_consent_stores_consents_revoke( &self, request: RevokeConsentRequest, name: &str ) -> ProjectLocationDatasetConsentStoreConsentRevokeCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.name
- Required. The resource name of the Consent to revoke, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is specified in the name.
sourcepub fn locations_datasets_consent_stores_user_data_mappings_archive(
&self,
request: ArchiveUserDataMappingRequest,
name: &str
) -> ProjectLocationDatasetConsentStoreUserDataMappingArchiveCall<'a, S>
pub fn locations_datasets_consent_stores_user_data_mappings_archive( &self, request: ArchiveUserDataMappingRequest, name: &str ) -> ProjectLocationDatasetConsentStoreUserDataMappingArchiveCall<'a, S>
Create a builder to help you perform the following task:
Archives the specified User data mapping.
§Arguments
request
- No description provided.name
- Required. The resource name of the User data mapping to archive.
sourcepub fn locations_datasets_consent_stores_user_data_mappings_create(
&self,
request: UserDataMapping,
parent: &str
) -> ProjectLocationDatasetConsentStoreUserDataMappingCreateCall<'a, S>
pub fn locations_datasets_consent_stores_user_data_mappings_create( &self, request: UserDataMapping, parent: &str ) -> ProjectLocationDatasetConsentStoreUserDataMappingCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new User data mapping in the parent consent store.
§Arguments
request
- No description provided.parent
- Required. Name of the consent store.
sourcepub fn locations_datasets_consent_stores_user_data_mappings_delete(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreUserDataMappingDeleteCall<'a, S>
pub fn locations_datasets_consent_stores_user_data_mappings_delete( &self, name: &str ) -> ProjectLocationDatasetConsentStoreUserDataMappingDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified User data mapping.
§Arguments
name
- Required. The resource name of the User data mapping to delete.
sourcepub fn locations_datasets_consent_stores_user_data_mappings_get(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreUserDataMappingGetCall<'a, S>
pub fn locations_datasets_consent_stores_user_data_mappings_get( &self, name: &str ) -> ProjectLocationDatasetConsentStoreUserDataMappingGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified User data mapping.
§Arguments
name
- Required. The resource name of the User data mapping to retrieve.
sourcepub fn locations_datasets_consent_stores_user_data_mappings_list(
&self,
parent: &str
) -> ProjectLocationDatasetConsentStoreUserDataMappingListCall<'a, S>
pub fn locations_datasets_consent_stores_user_data_mappings_list( &self, parent: &str ) -> ProjectLocationDatasetConsentStoreUserDataMappingListCall<'a, S>
Create a builder to help you perform the following task:
Lists the User data mappings in the specified consent store.
§Arguments
parent
- Required. Name of the consent store to retrieve User data mappings from.
sourcepub fn locations_datasets_consent_stores_user_data_mappings_patch(
&self,
request: UserDataMapping,
name: &str
) -> ProjectLocationDatasetConsentStoreUserDataMappingPatchCall<'a, S>
pub fn locations_datasets_consent_stores_user_data_mappings_patch( &self, request: UserDataMapping, name: &str ) -> ProjectLocationDatasetConsentStoreUserDataMappingPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates the specified User data mapping.
§Arguments
request
- No description provided.name
- Resource name of the User data mapping, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}
.
sourcepub fn locations_datasets_consent_stores_check_data_access(
&self,
request: CheckDataAccessRequest,
consent_store: &str
) -> ProjectLocationDatasetConsentStoreCheckDataAccesCall<'a, S>
pub fn locations_datasets_consent_stores_check_data_access( &self, request: CheckDataAccessRequest, consent_store: &str ) -> ProjectLocationDatasetConsentStoreCheckDataAccesCall<'a, S>
Create a builder to help you perform the following task:
Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
§Arguments
request
- No description provided.consentStore
- Required. Name of the consent store where the requested data_id is stored, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}
.
sourcepub fn locations_datasets_consent_stores_create(
&self,
request: ConsentStore,
parent: &str
) -> ProjectLocationDatasetConsentStoreCreateCall<'a, S>
pub fn locations_datasets_consent_stores_create( &self, request: ConsentStore, parent: &str ) -> ProjectLocationDatasetConsentStoreCreateCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.parent
- Required. The name of the dataset this consent store belongs to.
sourcepub fn locations_datasets_consent_stores_delete(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreDeleteCall<'a, S>
pub fn locations_datasets_consent_stores_delete( &self, name: &str ) -> ProjectLocationDatasetConsentStoreDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified consent store and removes all the consent store’s data.
§Arguments
name
- Required. The resource name of the consent store to delete.
sourcepub fn locations_datasets_consent_stores_evaluate_user_consents(
&self,
request: EvaluateUserConsentsRequest,
consent_store: &str
) -> ProjectLocationDatasetConsentStoreEvaluateUserConsentCall<'a, S>
pub fn locations_datasets_consent_stores_evaluate_user_consents( &self, request: EvaluateUserConsentsRequest, consent_store: &str ) -> ProjectLocationDatasetConsentStoreEvaluateUserConsentCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.consentStore
- Required. Name of the consent store to retrieve User data mappings from.
sourcepub fn locations_datasets_consent_stores_get(
&self,
name: &str
) -> ProjectLocationDatasetConsentStoreGetCall<'a, S>
pub fn locations_datasets_consent_stores_get( &self, name: &str ) -> ProjectLocationDatasetConsentStoreGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified consent store.
§Arguments
name
- Required. The resource name of the consent store to get.
sourcepub fn locations_datasets_consent_stores_get_iam_policy(
&self,
resource: &str
) -> ProjectLocationDatasetConsentStoreGetIamPolicyCall<'a, S>
pub fn locations_datasets_consent_stores_get_iam_policy( &self, resource: &str ) -> ProjectLocationDatasetConsentStoreGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
§Arguments
resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_consent_stores_list(
&self,
parent: &str
) -> ProjectLocationDatasetConsentStoreListCall<'a, S>
pub fn locations_datasets_consent_stores_list( &self, parent: &str ) -> ProjectLocationDatasetConsentStoreListCall<'a, S>
Create a builder to help you perform the following task:
Lists the consent stores in the specified dataset.
§Arguments
parent
- Required. Name of the dataset.
sourcepub fn locations_datasets_consent_stores_patch(
&self,
request: ConsentStore,
name: &str
) -> ProjectLocationDatasetConsentStorePatchCall<'a, S>
pub fn locations_datasets_consent_stores_patch( &self, request: ConsentStore, name: &str ) -> ProjectLocationDatasetConsentStorePatchCall<'a, S>
Create a builder to help you perform the following task:
Updates the specified consent store.
§Arguments
request
- No description provided.name
- Resource name of the consent store, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}
. Cannot be changed after creation.
sourcepub fn locations_datasets_consent_stores_query_accessible_data(
&self,
request: QueryAccessibleDataRequest,
consent_store: &str
) -> ProjectLocationDatasetConsentStoreQueryAccessibleDataCall<'a, S>
pub fn locations_datasets_consent_stores_query_accessible_data( &self, request: QueryAccessibleDataRequest, consent_store: &str ) -> ProjectLocationDatasetConsentStoreQueryAccessibleDataCall<'a, S>
Create a builder to help you perform the following task:
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"
§Arguments
request
- No description provided.consentStore
- Required. Name of the consent store to retrieve User data mappings from.
sourcepub fn locations_datasets_consent_stores_set_iam_policy(
&self,
request: SetIamPolicyRequest,
resource: &str
) -> ProjectLocationDatasetConsentStoreSetIamPolicyCall<'a, S>
pub fn locations_datasets_consent_stores_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationDatasetConsentStoreSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_consent_stores_test_iam_permissions(
&self,
request: TestIamPermissionsRequest,
resource: &str
) -> ProjectLocationDatasetConsentStoreTestIamPermissionCall<'a, S>
pub fn locations_datasets_consent_stores_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationDatasetConsentStoreTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_data_mapper_workspaces_get_iam_policy(
&self,
resource: &str
) -> ProjectLocationDatasetDataMapperWorkspaceGetIamPolicyCall<'a, S>
pub fn locations_datasets_data_mapper_workspaces_get_iam_policy( &self, resource: &str ) -> ProjectLocationDatasetDataMapperWorkspaceGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
§Arguments
resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_data_mapper_workspaces_set_iam_policy(
&self,
request: SetIamPolicyRequest,
resource: &str
) -> ProjectLocationDatasetDataMapperWorkspaceSetIamPolicyCall<'a, S>
pub fn locations_datasets_data_mapper_workspaces_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationDatasetDataMapperWorkspaceSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_data_mapper_workspaces_test_iam_permissions(
&self,
request: TestIamPermissionsRequest,
resource: &str
) -> ProjectLocationDatasetDataMapperWorkspaceTestIamPermissionCall<'a, S>
pub fn locations_datasets_data_mapper_workspaces_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationDatasetDataMapperWorkspaceTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_dicom_stores_dicom_web_studies_series_instances_get_storage_info(
&self,
resource: &str
) -> ProjectLocationDatasetDicomStoreDicomWebStudySeriesInstanceGetStorageInfoCall<'a, S>
pub fn locations_datasets_dicom_stores_dicom_web_studies_series_instances_get_storage_info( &self, resource: &str ) -> ProjectLocationDatasetDicomStoreDicomWebStudySeriesInstanceGetStorageInfoCall<'a, S>
Create a builder to help you perform the following task:
GetStorageInfo returns the storage info of the specified resource.
§Arguments
resource
- Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance:projects/{projectid}/datasets/{datasetid}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid}
)
sourcepub fn locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics(
&self,
series: &str
) -> ProjectLocationDatasetDicomStoreDicomWebStudySeriesGetSeriesMetricCall<'a, S>
pub fn locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics( &self, series: &str ) -> ProjectLocationDatasetDicomStoreDicomWebStudySeriesGetSeriesMetricCall<'a, S>
Create a builder to help you perform the following task:
GetSeriesMetrics returns metrics for a series.
§Arguments
series
- Required. The series resource path. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}
.
sourcepub fn locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics(
&self,
study: &str
) -> ProjectLocationDatasetDicomStoreDicomWebStudyGetStudyMetricCall<'a, S>
pub fn locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics( &self, study: &str ) -> ProjectLocationDatasetDicomStoreDicomWebStudyGetStudyMetricCall<'a, S>
Create a builder to help you perform the following task:
GetStudyMetrics returns metrics for a study.
§Arguments
study
- Required. The study resource path. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}
.
sourcepub fn locations_datasets_dicom_stores_dicom_web_studies_set_blob_storage_settings(
&self,
request: SetBlobStorageSettingsRequest,
resource: &str
) -> ProjectLocationDatasetDicomStoreDicomWebStudySetBlobStorageSettingCall<'a, S>
pub fn locations_datasets_dicom_stores_dicom_web_studies_set_blob_storage_settings( &self, request: SetBlobStorageSettingsRequest, resource: &str ) -> ProjectLocationDatasetDicomStoreDicomWebStudySetBlobStorageSettingCall<'a, S>
Create a builder to help you perform the following task:
SetBlobStorageSettings sets the blob storage settings of the specified resources.
§Arguments
request
- No description provided.resource
- Required. The path of the resource to update the blob storage settings in the format ofprojects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}
,projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/
, orprojects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}
. Iffilter_config
is specified, set the value ofresource
to the resource name of a DICOM store in the formatprojects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}
.
sourcepub fn locations_datasets_dicom_stores_studies_series_instances_bulkdata_retrieve_bulkdata(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceBulkdataRetrieveBulkdataCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_instances_bulkdata_retrieve_bulkdata( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceBulkdataRetrieveBulkdataCall<'a, S>
Create a builder to help you perform the following task:
Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4){: .external}. For details on the implementation of RetrieveBulkdata, see Bulkdata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see Retrieve bulkdata.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path for theRetrieveBulkdata
DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/bukdata/{bulkdata_uri}
.
sourcepub fn locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceFrameRetrieveFrameCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceFrameRetrieveFrameCall<'a, S>
Create a builder to help you perform the following task:
RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See RetrieveTransaction. For details on the implementation of RetrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieve DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveFrames DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}
.
sourcepub fn locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceFrameRetrieveRenderedCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceFrameRetrieveRenderedCall<'a, S>
Create a builder to help you perform the following task:
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See RetrieveTransaction. For details on the implementation of RetrieveRenderedFrames, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieve consumer image formats.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveRenderedFrames DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered
.
sourcepub fn locations_datasets_dicom_stores_studies_series_instances_delete(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceDeleteCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_instances_delete( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceDeleteCall<'a, S>
Create a builder to help you perform the following task:
DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see Delete a study, series, or instance.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the DeleteInstance request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}
.
sourcepub fn locations_datasets_dicom_stores_studies_series_instances_retrieve_instance(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceRetrieveInstanceCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceRetrieveInstanceCall<'a, S>
Create a builder to help you perform the following task:
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See RetrieveTransaction. For details on the implementation of RetrieveInstance, see DICOM study/series/instances and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieve an instance.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveInstance DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}
.
sourcepub fn locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceRetrieveMetadataCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceRetrieveMetadataCall<'a, S>
Create a builder to help you perform the following task:
RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See RetrieveTransaction. For details on the implementation of RetrieveInstanceMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieve metadata.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveInstanceMetadata DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata
.
sourcepub fn locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceRetrieveRenderedCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesInstanceRetrieveRenderedCall<'a, S>
Create a builder to help you perform the following task:
RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See RetrieveTransaction. For details on the implementation of RetrieveRenderedInstance, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieve consumer image formats.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveRenderedInstance DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered
.
sourcepub fn locations_datasets_dicom_stores_studies_series_delete(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesDeleteCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_delete( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesDeleteCall<'a, S>
Create a builder to help you perform the following task:
DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see Delete a study, series, or instance.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the DeleteSeries request. For example,studies/{study_uid}/series/{series_uid}
.
sourcepub fn locations_datasets_dicom_stores_studies_series_retrieve_metadata(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesRetrieveMetadataCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_retrieve_metadata( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesRetrieveMetadataCall<'a, S>
Create a builder to help you perform the following task:
RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See RetrieveTransaction. For details on the implementation of RetrieveSeriesMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieve metadata.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveSeriesMetadata DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/metadata
.
sourcepub fn locations_datasets_dicom_stores_studies_series_retrieve_series(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesRetrieveSeryCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_retrieve_series( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesRetrieveSeryCall<'a, S>
Create a builder to help you perform the following task:
RetrieveSeries returns all instances within the given study and series. See RetrieveTransaction. For details on the implementation of RetrieveSeries, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieve DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveSeries DICOMweb request. For example,studies/{study_uid}/series/{series_uid}
.
sourcepub fn locations_datasets_dicom_stores_studies_series_search_for_instances(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySeriesSearchForInstanceCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_series_search_for_instances( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySeriesSearchForInstanceCall<'a, S>
Create a builder to help you perform the following task:
SearchForInstances returns a list of matching instances. See RetrieveTransaction. For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the SearchForInstancesRequest DICOMweb request. For example,instances
,series/{series_uid}/instances
, orstudies/{study_uid}/instances
.
sourcepub fn locations_datasets_dicom_stores_studies_delete(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudyDeleteCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_delete( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudyDeleteCall<'a, S>
Create a builder to help you perform the following task:
DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see Delete a study, series, or instance.
§Arguments
parent
- No description provided.dicomWebPath
- Required. The path of the DeleteStudy request. For example,studies/{study_uid}
.
sourcepub fn locations_datasets_dicom_stores_studies_retrieve_metadata(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudyRetrieveMetadataCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_retrieve_metadata( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudyRetrieveMetadataCall<'a, S>
Create a builder to help you perform the following task:
RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See RetrieveTransaction. For details on the implementation of RetrieveStudyMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see Retrieve metadata.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveStudyMetadata DICOMweb request. For example,studies/{study_uid}/metadata
.
sourcepub fn locations_datasets_dicom_stores_studies_retrieve_study(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudyRetrieveStudyCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_retrieve_study( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudyRetrieveStudyCall<'a, S>
Create a builder to help you perform the following task:
RetrieveStudy returns all instances within the given study. See RetrieveTransaction. For details on the implementation of RetrieveStudy, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see Retrieve DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the RetrieveStudy DICOMweb request. For example,studies/{study_uid}
.
sourcepub fn locations_datasets_dicom_stores_studies_search_for_instances(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySearchForInstanceCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_search_for_instances( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySearchForInstanceCall<'a, S>
Create a builder to help you perform the following task:
SearchForInstances returns a list of matching instances. See RetrieveTransaction. For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the SearchForInstancesRequest DICOMweb request. For example,instances
,series/{series_uid}/instances
, orstudies/{study_uid}/instances
.
sourcepub fn locations_datasets_dicom_stores_studies_search_for_series(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudySearchForSeryCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_search_for_series( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudySearchForSeryCall<'a, S>
Create a builder to help you perform the following task:
SearchForSeries returns a list of matching series. See RetrieveTransaction. For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the SearchForSeries DICOMweb request. For example,series
orstudies/{study_uid}/series
.
sourcepub fn locations_datasets_dicom_stores_studies_store_instances(
&self,
request: HttpBody,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStudyStoreInstanceCall<'a, S>
pub fn locations_datasets_dicom_stores_studies_store_instances( &self, request: HttpBody, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStudyStoreInstanceCall<'a, S>
Create a builder to help you perform the following task:
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See Store Transaction. For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.
§Arguments
request
- No description provided.parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the StoreInstances DICOMweb request. For example,studies/[{study_uid}]
. Note that thestudy_uid
is optional.
sourcepub fn locations_datasets_dicom_stores_create(
&self,
request: DicomStore,
parent: &str
) -> ProjectLocationDatasetDicomStoreCreateCall<'a, S>
pub fn locations_datasets_dicom_stores_create( &self, request: DicomStore, parent: &str ) -> ProjectLocationDatasetDicomStoreCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new DICOM store within the parent dataset.
§Arguments
request
- No description provided.parent
- Required. The name of the dataset this DICOM store belongs to.
sourcepub fn locations_datasets_dicom_stores_deidentify(
&self,
request: DeidentifyDicomStoreRequest,
source_store: &str
) -> ProjectLocationDatasetDicomStoreDeidentifyCall<'a, S>
pub fn locations_datasets_dicom_stores_deidentify( &self, request: DeidentifyDicomStoreRequest, source_store: &str ) -> ProjectLocationDatasetDicomStoreDeidentifyCall<'a, S>
Create a builder to help you perform the following task:
De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.
§Arguments
request
- No description provided.sourceStore
- Required. Source DICOM store resource name. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.
sourcepub fn locations_datasets_dicom_stores_delete(
&self,
name: &str
) -> ProjectLocationDatasetDicomStoreDeleteCall<'a, S>
pub fn locations_datasets_dicom_stores_delete( &self, name: &str ) -> ProjectLocationDatasetDicomStoreDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified DICOM store and removes all images that are contained within it.
§Arguments
name
- Required. The resource name of the DICOM store to delete.
sourcepub fn locations_datasets_dicom_stores_export(
&self,
request: ExportDicomDataRequest,
name: &str
) -> ProjectLocationDatasetDicomStoreExportCall<'a, S>
pub fn locations_datasets_dicom_stores_export( &self, request: ExportDicomDataRequest, name: &str ) -> ProjectLocationDatasetDicomStoreExportCall<'a, S>
Create a builder to help you perform the following task:
Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see Viewing errors in Cloud Logging. The metadata field type is OperationMetadata.
§Arguments
request
- No description provided.name
- Required. The DICOM store resource name from which to export the data. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.
sourcepub fn locations_datasets_dicom_stores_get(
&self,
name: &str
) -> ProjectLocationDatasetDicomStoreGetCall<'a, S>
pub fn locations_datasets_dicom_stores_get( &self, name: &str ) -> ProjectLocationDatasetDicomStoreGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified DICOM store.
§Arguments
name
- Required. The resource name of the DICOM store to get.
sourcepub fn locations_datasets_dicom_stores_get_dicom_store_metrics(
&self,
name: &str
) -> ProjectLocationDatasetDicomStoreGetDICOMStoreMetricCall<'a, S>
pub fn locations_datasets_dicom_stores_get_dicom_store_metrics( &self, name: &str ) -> ProjectLocationDatasetDicomStoreGetDICOMStoreMetricCall<'a, S>
Create a builder to help you perform the following task:
Gets metrics associated with the DICOM store.
§Arguments
name
- Required. The resource name of the DICOM store to get metrics for.
sourcepub fn locations_datasets_dicom_stores_get_iam_policy(
&self,
resource: &str
) -> ProjectLocationDatasetDicomStoreGetIamPolicyCall<'a, S>
pub fn locations_datasets_dicom_stores_get_iam_policy( &self, resource: &str ) -> ProjectLocationDatasetDicomStoreGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
§Arguments
resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_dicom_stores_import(
&self,
request: ImportDicomDataRequest,
name: &str
) -> ProjectLocationDatasetDicomStoreImportCall<'a, S>
pub fn locations_datasets_dicom_stores_import( &self, request: ImportDicomDataRequest, name: &str ) -> ProjectLocationDatasetDicomStoreImportCall<'a, S>
Create a builder to help you perform the following task:
Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.
§Arguments
request
- No description provided.name
- Required. The name of the DICOM store resource into which the data is imported. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.
sourcepub fn locations_datasets_dicom_stores_list(
&self,
parent: &str
) -> ProjectLocationDatasetDicomStoreListCall<'a, S>
pub fn locations_datasets_dicom_stores_list( &self, parent: &str ) -> ProjectLocationDatasetDicomStoreListCall<'a, S>
Create a builder to help you perform the following task:
Lists the DICOM stores in the given dataset.
§Arguments
parent
- Required. Name of the dataset.
sourcepub fn locations_datasets_dicom_stores_patch(
&self,
request: DicomStore,
name: &str
) -> ProjectLocationDatasetDicomStorePatchCall<'a, S>
pub fn locations_datasets_dicom_stores_patch( &self, request: DicomStore, name: &str ) -> ProjectLocationDatasetDicomStorePatchCall<'a, S>
Create a builder to help you perform the following task:
Updates the specified DICOM store.
§Arguments
request
- No description provided.name
- Identifier. Resource name of the DICOM store, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.
sourcepub fn locations_datasets_dicom_stores_search_for_instances(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreSearchForInstanceCall<'a, S>
pub fn locations_datasets_dicom_stores_search_for_instances( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreSearchForInstanceCall<'a, S>
Create a builder to help you perform the following task:
SearchForInstances returns a list of matching instances. See RetrieveTransaction. For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the SearchForInstancesRequest DICOMweb request. For example,instances
,series/{series_uid}/instances
, orstudies/{study_uid}/instances
.
sourcepub fn locations_datasets_dicom_stores_search_for_series(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreSearchForSeryCall<'a, S>
pub fn locations_datasets_dicom_stores_search_for_series( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreSearchForSeryCall<'a, S>
Create a builder to help you perform the following task:
SearchForSeries returns a list of matching series. See RetrieveTransaction. For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the SearchForSeries DICOMweb request. For example,series
orstudies/{study_uid}/series
.
sourcepub fn locations_datasets_dicom_stores_search_for_studies(
&self,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreSearchForStudyCall<'a, S>
pub fn locations_datasets_dicom_stores_search_for_studies( &self, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreSearchForStudyCall<'a, S>
Create a builder to help you perform the following task:
SearchForStudies returns a list of matching studies. See RetrieveTransaction. For details on the implementation of SearchForStudies, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data.
§Arguments
parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the SearchForStudies DICOMweb request. For example,studies
.
sourcepub fn locations_datasets_dicom_stores_set_blob_storage_settings(
&self,
request: SetBlobStorageSettingsRequest,
resource: &str
) -> ProjectLocationDatasetDicomStoreSetBlobStorageSettingCall<'a, S>
pub fn locations_datasets_dicom_stores_set_blob_storage_settings( &self, request: SetBlobStorageSettingsRequest, resource: &str ) -> ProjectLocationDatasetDicomStoreSetBlobStorageSettingCall<'a, S>
Create a builder to help you perform the following task:
SetBlobStorageSettings sets the blob storage settings of the specified resources.
§Arguments
request
- No description provided.resource
- Required. The path of the resource to update the blob storage settings in the format ofprojects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}
,projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/
, orprojects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}
. Iffilter_config
is specified, set the value ofresource
to the resource name of a DICOM store in the formatprojects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}
.
sourcepub fn locations_datasets_dicom_stores_set_iam_policy(
&self,
request: SetIamPolicyRequest,
resource: &str
) -> ProjectLocationDatasetDicomStoreSetIamPolicyCall<'a, S>
pub fn locations_datasets_dicom_stores_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationDatasetDicomStoreSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_dicom_stores_store_instances(
&self,
request: HttpBody,
parent: &str,
dicom_web_path: &str
) -> ProjectLocationDatasetDicomStoreStoreInstanceCall<'a, S>
pub fn locations_datasets_dicom_stores_store_instances( &self, request: HttpBody, parent: &str, dicom_web_path: &str ) -> ProjectLocationDatasetDicomStoreStoreInstanceCall<'a, S>
Create a builder to help you perform the following task:
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See Store Transaction. For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.
§Arguments
request
- No description provided.parent
- Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
.dicomWebPath
- Required. The path of the StoreInstances DICOMweb request. For example,studies/[{study_uid}]
. Note that thestudy_uid
is optional.
sourcepub fn locations_datasets_dicom_stores_test_iam_permissions(
&self,
request: TestIamPermissionsRequest,
resource: &str
) -> ProjectLocationDatasetDicomStoreTestIamPermissionCall<'a, S>
pub fn locations_datasets_dicom_stores_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationDatasetDicomStoreTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_fhir_stores_fhir__concept_map_search_translate(
&self,
parent: &str
) -> ProjectLocationDatasetFhirStoreFhirConceptMapSearchTranslateCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__concept_map_search_translate( &self, parent: &str ) -> ProjectLocationDatasetFhirStoreFhirConceptMapSearchTranslateCall<'a, S>
Create a builder to help you perform the following task:
Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
§Arguments
parent
- Required. The name for the FHIR store containing the concept map(s) to use for the translation.
sourcepub fn locations_datasets_fhir_stores_fhir__concept_map_translate(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirConceptMapTranslateCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__concept_map_translate( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirConceptMapTranslateCall<'a, S>
Create a builder to help you perform the following task:
Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate operation (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
§Arguments
name
- Required. The URL for the concept map to use for the translation.
sourcepub fn locations_datasets_fhir_stores_fhir__consent_enforcement_status(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirConsentEnforcementStatuCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__consent_enforcement_status( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirConsentEnforcementStatuCall<'a, S>
Create a builder to help you perform the following task:
Returns the consent enforcement status of a single consent resource. On success, the response body contains a JSON-encoded representation of a Parameters
(http://hl7.org/fhir/parameters.html) FHIR resource, containing the current enforcement status. Does not support DSTU2.
§Arguments
name
- Required. The name of the consent resource to find enforcement status, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{consent_id}
sourcepub fn locations_datasets_fhir_stores_fhir__observation_lastn(
&self,
parent: &str
) -> ProjectLocationDatasetFhirStoreFhirObservationLastnCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__observation_lastn( &self, parent: &str ) -> ProjectLocationDatasetFhirStoreFhirObservationLastnCall<'a, S>
Create a builder to help you perform the following task:
Retrieves the N most recent Observation
resources for a subject matching search criteria specified as query parameters, grouped by Observation.code
, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn (STU3, R4). DSTU2 doesn’t define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - subject
or patient
to specify a subject for the Observation. - code
, category
or any of the composite parameters that include code
. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter max
, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with max
. To stay within the limit, constrain these searches using Observation search parameters such as _lastUpdated
or date
. On success, the response body contains a JSON-encoded representation of a Bundle
resource of type searchset
, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
§Arguments
parent
- Required. Name of the FHIR store to retrieve resources from.
sourcepub fn locations_datasets_fhir_stores_fhir__patient_consent_enforcement_status(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirPatientConsentEnforcementStatuCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__patient_consent_enforcement_status( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirPatientConsentEnforcementStatuCall<'a, S>
Create a builder to help you perform the following task:
Returns the consent enforcement status of all consent resources for a patient. On success, the response body contains a JSON-encoded representation of a bundle of Parameters
(http://hl7.org/fhir/parameters.html) FHIR resources, containing the current enforcement status for each consent resource of the patient. Does not support DSTU2.
§Arguments
name
- Required. The name of the patient to find enforcement statuses, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{patient_id}
sourcepub fn locations_datasets_fhir_stores_fhir__patient_everything(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirPatientEverythingCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__patient_everything( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirPatientEverythingCall<'a, S>
Create a builder to help you perform the following task:
Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of a Bundle
resource of type searchset
, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition (DSTU2, STU3, R4), which details the eligible resource types and referencing search parameters. For samples that show how to call Patient-everything
, see Getting all patient compartment resources.
§Arguments
name
- Required. Name of thePatient
resource for which the information is required.
sourcepub fn locations_datasets_fhir_stores_fhir__resource_incoming_references(
&self,
parent: &str
) -> ProjectLocationDatasetFhirStoreFhirResourceIncomingReferenceCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__resource_incoming_references( &self, parent: &str ) -> ProjectLocationDatasetFhirStoreFhirResourceIncomingReferenceCall<'a, S>
Create a builder to help you perform the following task:
Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn’t exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type searchset
, where each entry in the Bundle contains the full content of the resource. If the operation fails, an OperationOutcome
is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.
§Arguments
parent
- Required. The name of the FHIR store that holds the target resource.
sourcepub fn locations_datasets_fhir_stores_fhir__resource_purge(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirResourcePurgeCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__resource_purge( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirResourcePurgeCall<'a, S>
Create a builder to help you perform the following task:
Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call Resource-purge
, see Deleting historical versions of a FHIR resource.
§Arguments
name
- Required. The name of the resource to purge.
sourcepub fn locations_datasets_fhir_stores_fhir__resource_validate(
&self,
request: HttpBody,
parent: &str,
type_: &str
) -> ProjectLocationDatasetFhirStoreFhirResourceValidateCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir__resource_validate( &self, request: HttpBody, parent: &str, type_: &str ) -> ProjectLocationDatasetFhirStoreFhirResourceValidateCall<'a, S>
Create a builder to help you perform the following task:
Validates an input FHIR resource’s conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate (DSTU2, STU3, or R4). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json
. The Parameters
input syntax is not supported. The profile
query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
§Arguments
request
- No description provided.parent
- Required. The name of the FHIR store that holds the profiles being used for validation.type
- Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index (DSTU2, STU3, or R4). Must match the resource type in the provided content.
sourcepub fn locations_datasets_fhir_stores_fhir_capabilities(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirCapabilityCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_capabilities( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirCapabilityCall<'a, S>
Create a builder to help you perform the following task:
Gets the FHIR capability statement (STU3, R4), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction (STU3, R4), or the conformance interaction in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a CapabilityStatement
resource.
§Arguments
name
- Required. Name of the FHIR store to retrieve the capabilities for.
sourcepub fn locations_datasets_fhir_stores_fhir_conditional_delete(
&self,
parent: &str,
type_: &str
) -> ProjectLocationDatasetFhirStoreFhirConditionalDeleteCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_conditional_delete( &self, parent: &str, type_: &str ) -> ProjectLocationDatasetFhirStoreFhirConditionalDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction (DSTU2, STU3, R4). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the _count
query parameter. Even when using _count
, you can delete a maximum 1,000 FHIR resources per each call of conditionalDelete
. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires thehealthcare.fhirStores.searchResources
and healthcare.fhirResources.delete
permissions on the parent FHIR store. For samples that show how to call conditionalDelete
, see Conditionally deleting a FHIR resource.
§Arguments
sourcepub fn locations_datasets_fhir_stores_fhir_conditional_patch(
&self,
request: HttpBody,
parent: &str,
type_: &str
) -> ProjectLocationDatasetFhirStoreFhirConditionalPatchCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_conditional_patch( &self, request: HttpBody, parent: &str, type_: &str ) -> ProjectLocationDatasetFhirStoreFhirConditionalPatchCall<'a, S>
Create a builder to help you perform the following task:
If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a JSON Patch document. Implements the FHIR standard conditional patch interaction (STU3, R4). DSTU2 doesn’t define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a 412 Precondition Failed
error. The request body must contain a JSON Patch document, and the request headers must contain Content-Type: application/json-patch+json
. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires thehealthcare.fhirStores.searchResources
permission on the parent FHIR store and the healthcare.fhirResources.patch
permission on the requested FHIR store resource. For samples that show how to call conditionalPatch
, see Conditionally patching a FHIR resource.
§Arguments
sourcepub fn locations_datasets_fhir_stores_fhir_conditional_update(
&self,
request: HttpBody,
parent: &str,
type_: &str
) -> ProjectLocationDatasetFhirStoreFhirConditionalUpdateCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_conditional_update( &self, request: HttpBody, parent: &str, type_: &str ) -> ProjectLocationDatasetFhirStoreFhirConditionalUpdateCall<'a, S>
Create a builder to help you perform the following task:
If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction (DSTU2, STU3, R4). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a 412 Precondition Failed
error. If the search criteria identify zero matches, and the supplied resource body contains an id
, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an id
, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json
. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires thehealthcare.fhirStores.searchResources
and healthcare.fhirResources.update
permissions on the parent FHIR store. For samples that show how to call conditionalUpdate
, see Conditionally updating a FHIR resource.
§Arguments
request
- No description provided.parent
- Required. The name of the FHIR store this resource belongs to.type
- Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). Must match the resource type in the provided content.
sourcepub fn locations_datasets_fhir_stores_fhir_create(
&self,
request: HttpBody,
parent: &str,
type_: &str
) -> ProjectLocationDatasetFhirStoreFhirCreateCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_create( &self, request: HttpBody, parent: &str, type_: &str ) -> ProjectLocationDatasetFhirStoreFhirCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a FHIR resource. Implements the FHIR standard create interaction (DSTU2, STU3, R4), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction (DSTU2, STU3, R4), specified by supplying an If-None-Exist
header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json
. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call create
, see Creating a FHIR resource.
§Arguments
request
- No description provided.parent
- Required. The name of the FHIR store this resource belongs to.type
- Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). Must match the resource type in the provided content.
sourcepub fn locations_datasets_fhir_stores_fhir_delete(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirDeleteCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_delete( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a FHIR resource. Implements the FHIR standard delete interaction (DSTU2, STU3, R4). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call delete
, see Deleting a FHIR resource.
§Arguments
name
- Required. The name of the resource to delete.
sourcepub fn locations_datasets_fhir_stores_fhir_execute_bundle(
&self,
request: HttpBody,
parent: &str
) -> ProjectLocationDatasetFhirStoreFhirExecuteBundleCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_execute_bundle( &self, request: HttpBody, parent: &str ) -> ProjectLocationDatasetFhirStoreFhirExecuteBundleCall<'a, S>
Create a builder to help you perform the following task:
Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. (DSTU2, STU3, R4). Supports all interactions within a bundle, except search. This method accepts Bundles of type batch
, transaction
and history
, processing batch
and transaction
bundles according to the batch processing rules (DSTU2, STU3, R4) and transaction processing rules (DSTU2, STU3, R4). The request body must contain a JSON-encoded FHIR Bundle
resource, and the request headers must contain Content-Type: application/fhir+json
. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a Bundle
resource of type batch-response
or transaction-response
containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction
or history
bundle, the response body contains a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The executeBundle
permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the healthcare.fhirResources.create
permission. history
bundles also check the import
permission. You can use audit logs to view the permissions for executeBundle
and each request in the bundle. For more information, see Viewing Cloud Audit logs. For samples that show how to call executeBundle
, see Managing FHIR resources using FHIR bundles.
§Arguments
request
- No description provided.parent
- Required. Name of the FHIR store in which this bundle will be executed.
sourcepub fn locations_datasets_fhir_stores_fhir_history(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirHistoryCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_history( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirHistoryCall<'a, S>
Create a builder to help you perform the following task:
Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of a Bundle
resource of type history
, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call history
, see Listing FHIR resource versions.
§Arguments
name
- Required. The name of the resource to retrieve.
sourcepub fn locations_datasets_fhir_stores_fhir_patch(
&self,
request: HttpBody,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirPatchCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_patch( &self, request: HttpBody, name: &str ) -> ProjectLocationDatasetFhirStoreFhirPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates part of an existing resource by applying the operations specified in a JSON Patch document. Implements the FHIR standard patch interaction (STU3, R4). DSTU2 doesn’t define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain Content-Type: application/json-patch+json
. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call patch
, see Patching a FHIR resource.
§Arguments
request
- No description provided.name
- Required. The name of the resource to update.
sourcepub fn locations_datasets_fhir_stores_fhir_read(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirReadCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_read( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirReadCall<'a, S>
Create a builder to help you perform the following task:
Gets the contents of a FHIR resource. Implements the FHIR standard read interaction (DSTU2, STU3, R4). Also supports the FHIR standard conditional read interaction (DSTU2, STU3, R4) specified by supplying an If-Modified-Since
header with a date/time value or an If-None-Match
header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call read
, see Getting a FHIR resource.
§Arguments
name
- Required. The name of the resource to retrieve.
sourcepub fn locations_datasets_fhir_stores_fhir_search(
&self,
request: SearchResourcesRequest,
parent: &str
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_search( &self, request: SearchResourcesRequest, parent: &str ) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, S>
Create a builder to help you perform the following task:
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). Supports four methods of search defined by the specification: * GET [base]?[parameters]
to search across all resources. * GET [base]/[type]?[parameters]
to search resources of a specified type. * POST [base]/_search?[parameters]
as an alternate form having the same semantics as the GET
method across all resources. * POST [base]/[type]/_search?[parameters]
as an alternate form having the same semantics as the GET
method for the specified type. The GET
and POST
methods do not support compartment searches. The POST
method does not support application/x-www-form-urlencoded
search parameters. On success, the response body contains a JSON-encoded representation of a Bundle
resource of type searchset
, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server’s capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3, R4). FHIR search parameters for DSTU2 can be found on each resource’s definition page. Supported search modifiers: :missing
, :exact
, :contains
, :text
, :in
, :not-in
, :above
, :below
, :[type]
, :not
, and recurse
(DSTU2 and STU3) or :iterate
(R4). Supported search result parameters: _sort
, _count
, _include
, _revinclude
, _summary=text
, _summary=data
, and _elements
. The maximum number of search results returned defaults to 100, which can be overridden by the _count
parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned Bundle
contains a link of relation
“next”, which has a _page_token
parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern identifier=[system]|[value]
or identifier=[value]
, and any of the following search result parameters can be used: * _count
* _include
* _revinclude
* _summary
* _elements
If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn’t optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional _sort
parameter in your query. Use _sort=-_lastUpdated
if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see Searching for FHIR resources and Advanced FHIR search features.
§Arguments
request
- No description provided.parent
- Required. Name of the FHIR store to retrieve resources from.
sourcepub fn locations_datasets_fhir_stores_fhir_search_type(
&self,
request: SearchResourcesRequest,
parent: &str,
resource_type: &str
) -> ProjectLocationDatasetFhirStoreFhirSearchTypeCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_search_type( &self, request: SearchResourcesRequest, parent: &str, resource_type: &str ) -> ProjectLocationDatasetFhirStoreFhirSearchTypeCall<'a, S>
Create a builder to help you perform the following task:
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). Supports four methods of search defined by the specification: * GET [base]?[parameters]
to search across all resources. * GET [base]/[type]?[parameters]
to search resources of a specified type. * POST [base]/_search?[parameters]
as an alternate form having the same semantics as the GET
method across all resources. * POST [base]/[type]/_search?[parameters]
as an alternate form having the same semantics as the GET
method for the specified type. The GET
and POST
methods do not support compartment searches. The POST
method does not support application/x-www-form-urlencoded
search parameters. On success, the response body contains a JSON-encoded representation of a Bundle
resource of type searchset
, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server’s capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3, R4). FHIR search parameters for DSTU2 can be found on each resource’s definition page. Supported search modifiers: :missing
, :exact
, :contains
, :text
, :in
, :not-in
, :above
, :below
, :[type]
, :not
, and recurse
(DSTU2 and STU3) or :iterate
(R4). Supported search result parameters: _sort
, _count
, _include
, _revinclude
, _summary=text
, _summary=data
, and _elements
. The maximum number of search results returned defaults to 100, which can be overridden by the _count
parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned Bundle
contains a link of relation
“next”, which has a _page_token
parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern identifier=[system]|[value]
or identifier=[value]
, and any of the following search result parameters can be used: * _count
* _include
* _revinclude
* _summary
* _elements
If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn’t optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional _sort
parameter in your query. Use _sort=-_lastUpdated
if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see Searching for FHIR resources and Advanced FHIR search features.
§Arguments
sourcepub fn locations_datasets_fhir_stores_fhir_update(
&self,
request: HttpBody,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirUpdateCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_update( &self, request: HttpBody, name: &str ) -> ProjectLocationDatasetFhirStoreFhirUpdateCall<'a, S>
Create a builder to help you perform the following task:
Updates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2, STU3, R4). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json
. The resource must contain an id
element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call update
, see Updating a FHIR resource.
§Arguments
request
- No description provided.name
- Required. The name of the resource to update.
sourcepub fn locations_datasets_fhir_stores_fhir_vread(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreFhirVreadCall<'a, S>
pub fn locations_datasets_fhir_stores_fhir_vread( &self, name: &str ) -> ProjectLocationDatasetFhirStoreFhirVreadCall<'a, S>
Create a builder to help you perform the following task:
Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call vread
, see Retrieving a FHIR resource version.
§Arguments
name
- Required. The name of the resource version to retrieve.
sourcepub fn locations_datasets_fhir_stores_apply_admin_consents(
&self,
request: ApplyAdminConsentsRequest,
name: &str
) -> ProjectLocationDatasetFhirStoreApplyAdminConsentCall<'a, S>
pub fn locations_datasets_fhir_stores_apply_admin_consents( &self, request: ApplyAdminConsentsRequest, name: &str ) -> ProjectLocationDatasetFhirStoreApplyAdminConsentCall<'a, S>
Create a builder to help you perform the following task:
Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the consent_config.enforced_admin_consents
field of the FhirStore unless validate_only=true
in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the consent_config.enforced_admin_consents
field will be unchanged. To enforce a consent check for data access, consent_config.access_enforced
must be set to true for the FhirStore.
§Arguments
request
- No description provided.name
- Required. The name of the FHIR store to enforce, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
sourcepub fn locations_datasets_fhir_stores_apply_consents(
&self,
request: ApplyConsentsRequest,
name: &str
) -> ProjectLocationDatasetFhirStoreApplyConsentCall<'a, S>
pub fn locations_datasets_fhir_stores_apply_consents( &self, request: ApplyConsentsRequest, name: &str ) -> ProjectLocationDatasetFhirStoreApplyConsentCall<'a, S>
Create a builder to help you perform the following task:
Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). To enforce consent check for data access, consent_config.access_enforced
must be set to true for the FhirStore.
§Arguments
request
- No description provided.name
- Required. The name of the FHIR store to enforce, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
sourcepub fn locations_datasets_fhir_stores_configure_search(
&self,
request: ConfigureSearchRequest,
name: &str
) -> ProjectLocationDatasetFhirStoreConfigureSearchCall<'a, S>
pub fn locations_datasets_fhir_stores_configure_search( &self, request: ConfigureSearchRequest, name: &str ) -> ProjectLocationDatasetFhirStoreConfigureSearchCall<'a, S>
Create a builder to help you perform the following task:
Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation.
§Arguments
request
- No description provided.name
- Required. The name of the FHIR store to configure, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
sourcepub fn locations_datasets_fhir_stores_create(
&self,
request: FhirStore,
parent: &str
) -> ProjectLocationDatasetFhirStoreCreateCall<'a, S>
pub fn locations_datasets_fhir_stores_create( &self, request: FhirStore, parent: &str ) -> ProjectLocationDatasetFhirStoreCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new FHIR store within the parent dataset.
§Arguments
request
- No description provided.parent
- Required. The name of the dataset this FHIR store belongs to.
sourcepub fn locations_datasets_fhir_stores_deidentify(
&self,
request: DeidentifyFhirStoreRequest,
source_store: &str
) -> ProjectLocationDatasetFhirStoreDeidentifyCall<'a, S>
pub fn locations_datasets_fhir_stores_deidentify( &self, request: DeidentifyFhirStoreRequest, source_store: &str ) -> ProjectLocationDatasetFhirStoreDeidentifyCall<'a, S>
Create a builder to help you perform the following task:
De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.
§Arguments
request
- No description provided.sourceStore
- Required. Source FHIR store resource name. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
sourcepub fn locations_datasets_fhir_stores_delete(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreDeleteCall<'a, S>
pub fn locations_datasets_fhir_stores_delete( &self, name: &str ) -> ProjectLocationDatasetFhirStoreDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified FHIR store and removes all resources within it.
§Arguments
name
- Required. The resource name of the FHIR store to delete.
sourcepub fn locations_datasets_fhir_stores_explain_data_access(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreExplainDataAccesCall<'a, S>
pub fn locations_datasets_fhir_stores_explain_data_access( &self, name: &str ) -> ProjectLocationDatasetFhirStoreExplainDataAccesCall<'a, S>
Create a builder to help you perform the following task:
Explains all the permitted/denied actor, purpose and environment for a given resource.
§Arguments
name
- Required. The name of the FHIR store to enforce, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
sourcepub fn locations_datasets_fhir_stores_export(
&self,
request: ExportResourcesRequest,
name: &str
) -> ProjectLocationDatasetFhirStoreExportCall<'a, S>
pub fn locations_datasets_fhir_stores_export( &self, request: ExportResourcesRequest, name: &str ) -> ProjectLocationDatasetFhirStoreExportCall<'a, S>
Create a builder to help you perform the following task:
Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
§Arguments
request
- No description provided.name
- Required. The name of the FHIR store to export resource from, in the format ofprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
sourcepub fn locations_datasets_fhir_stores_get(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreGetCall<'a, S>
pub fn locations_datasets_fhir_stores_get( &self, name: &str ) -> ProjectLocationDatasetFhirStoreGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the configuration of the specified FHIR store.
§Arguments
name
- Required. The resource name of the FHIR store to get.
sourcepub fn locations_datasets_fhir_stores_get_fhir_store_metrics(
&self,
name: &str
) -> ProjectLocationDatasetFhirStoreGetFHIRStoreMetricCall<'a, S>
pub fn locations_datasets_fhir_stores_get_fhir_store_metrics( &self, name: &str ) -> ProjectLocationDatasetFhirStoreGetFHIRStoreMetricCall<'a, S>
Create a builder to help you perform the following task:
Gets metrics associated with the FHIR store.
§Arguments
name
- Required. The resource name of the FHIR store to get metrics for.
sourcepub fn locations_datasets_fhir_stores_get_iam_policy(
&self,
resource: &str
) -> ProjectLocationDatasetFhirStoreGetIamPolicyCall<'a, S>
pub fn locations_datasets_fhir_stores_get_iam_policy( &self, resource: &str ) -> ProjectLocationDatasetFhirStoreGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
§Arguments
resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_fhir_stores_import(
&self,
request: ImportResourcesRequest,
name: &str
) -> ProjectLocationDatasetFhirStoreImportCall<'a, S>
pub fn locations_datasets_fhir_stores_import( &self, request: ImportResourcesRequest, name: &str ) -> ProjectLocationDatasetFhirStoreImportCall<'a, S>
Create a builder to help you perform the following task:
Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data are specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the BUNDLE
format. When using the BUNDLE
format this method ignores the Bundle.type
field, except that history
bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in Bundle.entry.resource
, ignoring Bundle.entry.request
. As an example, this allows the import of searchset
bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
§Arguments
request
- No description provided.name
- Required. The name of the FHIR store to import FHIR resources to, in the format ofprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
sourcepub fn locations_datasets_fhir_stores_list(
&self,
parent: &str
) -> ProjectLocationDatasetFhirStoreListCall<'a, S>
pub fn locations_datasets_fhir_stores_list( &self, parent: &str ) -> ProjectLocationDatasetFhirStoreListCall<'a, S>
Create a builder to help you perform the following task:
Lists the FHIR stores in the given dataset.
§Arguments
parent
- Required. Name of the dataset.
sourcepub fn locations_datasets_fhir_stores_patch(
&self,
request: FhirStore,
name: &str
) -> ProjectLocationDatasetFhirStorePatchCall<'a, S>
pub fn locations_datasets_fhir_stores_patch( &self, request: FhirStore, name: &str ) -> ProjectLocationDatasetFhirStorePatchCall<'a, S>
Create a builder to help you perform the following task:
Updates the configuration of the specified FHIR store.
§Arguments
request
- No description provided.name
- Output only. Identifier. Resource name of the FHIR store, of the formprojects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
sourcepub fn locations_datasets_fhir_stores_rollback(
&self,
request: RollbackFhirResourcesRequest,
name: &str
) -> ProjectLocationDatasetFhirStoreRollbackCall<'a, S>
pub fn locations_datasets_fhir_stores_rollback( &self, request: RollbackFhirResourcesRequest, name: &str ) -> ProjectLocationDatasetFhirStoreRollbackCall<'a, S>
Create a builder to help you perform the following task:
Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
§Arguments
request
- No description provided.name
- Required. The name of the FHIR store to rollback, in the format of “projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}”.
sourcepub fn locations_datasets_fhir_stores_set_iam_policy(
&self,
request: SetIamPolicyRequest,
resource: &str
) -> ProjectLocationDatasetFhirStoreSetIamPolicyCall<'a, S>
pub fn locations_datasets_fhir_stores_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationDatasetFhirStoreSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_fhir_stores_test_iam_permissions(
&self,
request: TestIamPermissionsRequest,
resource: &str
) -> ProjectLocationDatasetFhirStoreTestIamPermissionCall<'a, S>
pub fn locations_datasets_fhir_stores_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationDatasetFhirStoreTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_hl7_v2_stores_messages_batch_get(
&self,
parent: &str
) -> ProjectLocationDatasetHl7V2StoreMessageBatchGetCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_messages_batch_get( &self, parent: &str ) -> ProjectLocationDatasetHl7V2StoreMessageBatchGetCall<'a, S>
Create a builder to help you perform the following task:
Gets multiple messages in the given HL7v2 store.
§Arguments
parent
- Required. Name of the HL7v2 store to retrieve messages from, in the format:projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}
.
sourcepub fn locations_datasets_hl7_v2_stores_messages_create(
&self,
request: CreateMessageRequest,
parent: &str
) -> ProjectLocationDatasetHl7V2StoreMessageCreateCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_messages_create( &self, request: CreateMessageRequest, parent: &str ) -> ProjectLocationDatasetHl7V2StoreMessageCreateCall<'a, S>
Create a builder to help you perform the following task:
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received.
§Arguments
request
- No description provided.parent
- Required. The name of the HL7v2 store this message belongs to.
sourcepub fn locations_datasets_hl7_v2_stores_messages_delete(
&self,
name: &str
) -> ProjectLocationDatasetHl7V2StoreMessageDeleteCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_messages_delete( &self, name: &str ) -> ProjectLocationDatasetHl7V2StoreMessageDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes an HL7v2 message.
§Arguments
name
- Required. The resource name of the HL7v2 message to delete.
sourcepub fn locations_datasets_hl7_v2_stores_messages_get(
&self,
name: &str
) -> ProjectLocationDatasetHl7V2StoreMessageGetCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_messages_get( &self, name: &str ) -> ProjectLocationDatasetHl7V2StoreMessageGetCall<'a, S>
Create a builder to help you perform the following task:
Gets an HL7v2 message.
§Arguments
name
- Required. The resource name of the HL7v2 message to retrieve.
sourcepub fn locations_datasets_hl7_v2_stores_messages_ingest(
&self,
request: IngestMessageRequest,
parent: &str
) -> ProjectLocationDatasetHl7V2StoreMessageIngestCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_messages_ingest( &self, request: IngestMessageRequest, parent: &str ) -> ProjectLocationDatasetHl7V2StoreMessageIngestCall<'a, S>
Create a builder to help you perform the following task:
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (ACK
) message. If the method encounters an error, it returns a negative acknowledgment (NACK
) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments.
§Arguments
request
- No description provided.parent
- Required. The name of the HL7v2 store this message belongs to.
sourcepub fn locations_datasets_hl7_v2_stores_messages_list(
&self,
parent: &str
) -> ProjectLocationDatasetHl7V2StoreMessageListCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_messages_list( &self, parent: &str ) -> ProjectLocationDatasetHl7V2StoreMessageListCall<'a, S>
Create a builder to help you perform the following task:
Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter.
§Arguments
parent
- Required. Name of the HL7v2 store to retrieve messages from.
sourcepub fn locations_datasets_hl7_v2_stores_messages_patch(
&self,
request: Message,
name: &str
) -> ProjectLocationDatasetHl7V2StoreMessagePatchCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_messages_patch( &self, request: Message, name: &str ) -> ProjectLocationDatasetHl7V2StoreMessagePatchCall<'a, S>
Create a builder to help you perform the following task:
Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time can’t be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.
§Arguments
request
- No description provided.name
- Output only. Resource name of the Message, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}
. Assigned by the server.
sourcepub fn locations_datasets_hl7_v2_stores_create(
&self,
request: Hl7V2Store,
parent: &str
) -> ProjectLocationDatasetHl7V2StoreCreateCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_create( &self, request: Hl7V2Store, parent: &str ) -> ProjectLocationDatasetHl7V2StoreCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new HL7v2 store within the parent dataset.
§Arguments
request
- No description provided.parent
- Required. The name of the dataset this HL7v2 store belongs to.
sourcepub fn locations_datasets_hl7_v2_stores_delete(
&self,
name: &str
) -> ProjectLocationDatasetHl7V2StoreDeleteCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_delete( &self, name: &str ) -> ProjectLocationDatasetHl7V2StoreDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified HL7v2 store and removes all messages that it contains.
§Arguments
name
- Required. The resource name of the HL7v2 store to delete.
sourcepub fn locations_datasets_hl7_v2_stores_export(
&self,
request: ExportMessagesRequest,
name: &str
) -> ProjectLocationDatasetHl7V2StoreExportCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_export( &self, request: ExportMessagesRequest, name: &str ) -> ProjectLocationDatasetHl7V2StoreExportCall<'a, S>
Create a builder to help you perform the following task:
Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
§Arguments
request
- No description provided.name
- Required. The name of the source HL7v2 store, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}
sourcepub fn locations_datasets_hl7_v2_stores_get(
&self,
name: &str
) -> ProjectLocationDatasetHl7V2StoreGetCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_get( &self, name: &str ) -> ProjectLocationDatasetHl7V2StoreGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the specified HL7v2 store.
§Arguments
name
- Required. The resource name of the HL7v2 store to get.
sourcepub fn locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics(
&self,
name: &str
) -> ProjectLocationDatasetHl7V2StoreGetHL7v2StoreMetricCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics( &self, name: &str ) -> ProjectLocationDatasetHl7V2StoreGetHL7v2StoreMetricCall<'a, S>
Create a builder to help you perform the following task:
Gets metrics associated with the HL7v2 store.
§Arguments
name
- Required. The resource name of the HL7v2 store to get metrics for, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}
.
sourcepub fn locations_datasets_hl7_v2_stores_get_iam_policy(
&self,
resource: &str
) -> ProjectLocationDatasetHl7V2StoreGetIamPolicyCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_get_iam_policy( &self, resource: &str ) -> ProjectLocationDatasetHl7V2StoreGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
§Arguments
resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_hl7_v2_stores_import(
&self,
request: ImportMessagesRequest,
name: &str
) -> ProjectLocationDatasetHl7V2StoreImportCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_import( &self, request: ImportMessagesRequest, name: &str ) -> ProjectLocationDatasetHl7V2StoreImportCall<'a, S>
Create a builder to help you perform the following task:
Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
§Arguments
request
- No description provided.name
- Required. The name of the target HL7v2 store, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}
sourcepub fn locations_datasets_hl7_v2_stores_list(
&self,
parent: &str
) -> ProjectLocationDatasetHl7V2StoreListCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_list( &self, parent: &str ) -> ProjectLocationDatasetHl7V2StoreListCall<'a, S>
Create a builder to help you perform the following task:
Lists the HL7v2 stores in the given dataset.
§Arguments
parent
- Required. Name of the dataset.
sourcepub fn locations_datasets_hl7_v2_stores_patch(
&self,
request: Hl7V2Store,
name: &str
) -> ProjectLocationDatasetHl7V2StorePatchCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_patch( &self, request: Hl7V2Store, name: &str ) -> ProjectLocationDatasetHl7V2StorePatchCall<'a, S>
Create a builder to help you perform the following task:
Updates the HL7v2 store.
§Arguments
request
- No description provided.name
- Identifier. Resource name of the HL7v2 store, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}
.
sourcepub fn locations_datasets_hl7_v2_stores_set_iam_policy(
&self,
request: SetIamPolicyRequest,
resource: &str
) -> ProjectLocationDatasetHl7V2StoreSetIamPolicyCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationDatasetHl7V2StoreSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_hl7_v2_stores_test_iam_permissions(
&self,
request: TestIamPermissionsRequest,
resource: &str
) -> ProjectLocationDatasetHl7V2StoreTestIamPermissionCall<'a, S>
pub fn locations_datasets_hl7_v2_stores_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationDatasetHl7V2StoreTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_operations_cancel(
&self,
request: CancelOperationRequest,
name: &str
) -> ProjectLocationDatasetOperationCancelCall<'a, S>
pub fn locations_datasets_operations_cancel( &self, request: CancelOperationRequest, name: &str ) -> ProjectLocationDatasetOperationCancelCall<'a, S>
Create a builder to help you perform the following task:
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
§Arguments
request
- No description provided.name
- The name of the operation resource to be cancelled.
sourcepub fn locations_datasets_operations_get(
&self,
name: &str
) -> ProjectLocationDatasetOperationGetCall<'a, S>
pub fn locations_datasets_operations_get( &self, name: &str ) -> ProjectLocationDatasetOperationGetCall<'a, S>
Create a builder to help you perform the following task:
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
§Arguments
name
- The name of the operation resource.
sourcepub fn locations_datasets_operations_list(
&self,
name: &str
) -> ProjectLocationDatasetOperationListCall<'a, S>
pub fn locations_datasets_operations_list( &self, name: &str ) -> ProjectLocationDatasetOperationListCall<'a, S>
Create a builder to help you perform the following task:
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED
.
§Arguments
name
- The name of the operation’s parent resource.
sourcepub fn locations_datasets_create(
&self,
request: Dataset,
parent: &str
) -> ProjectLocationDatasetCreateCall<'a, S>
pub fn locations_datasets_create( &self, request: Dataset, parent: &str ) -> ProjectLocationDatasetCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response
which contains a Dataset or Operation.error
. The metadata field type is OperationMetadata.
§Arguments
request
- No description provided.parent
- Required. The name of the project where the server creates the dataset. For example,projects/{project_id}/locations/{location_id}
.
sourcepub fn locations_datasets_deidentify(
&self,
request: DeidentifyDatasetRequest,
source_dataset: &str
) -> ProjectLocationDatasetDeidentifyCall<'a, S>
pub fn locations_datasets_deidentify( &self, request: DeidentifyDatasetRequest, source_dataset: &str ) -> ProjectLocationDatasetDeidentifyCall<'a, S>
Create a builder to help you perform the following task:
Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. The LRO result may still be successful if de-identification fails for some resources. The new de-identified dataset will not contain these failed resources. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.
§Arguments
request
- No description provided.sourceDataset
- Required. Source dataset resource name. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
.
sourcepub fn locations_datasets_delete(
&self,
name: &str
) -> ProjectLocationDatasetDeleteCall<'a, S>
pub fn locations_datasets_delete( &self, name: &str ) -> ProjectLocationDatasetDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).
§Arguments
name
- Required. The name of the dataset to delete. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
.
sourcepub fn locations_datasets_get(
&self,
name: &str
) -> ProjectLocationDatasetGetCall<'a, S>
pub fn locations_datasets_get( &self, name: &str ) -> ProjectLocationDatasetGetCall<'a, S>
Create a builder to help you perform the following task:
Gets any metadata associated with a dataset.
§Arguments
name
- Required. The name of the dataset to read. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
.
sourcepub fn locations_datasets_get_iam_policy(
&self,
resource: &str
) -> ProjectLocationDatasetGetIamPolicyCall<'a, S>
pub fn locations_datasets_get_iam_policy( &self, resource: &str ) -> ProjectLocationDatasetGetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
§Arguments
resource
- REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_list(
&self,
parent: &str
) -> ProjectLocationDatasetListCall<'a, S>
pub fn locations_datasets_list( &self, parent: &str ) -> ProjectLocationDatasetListCall<'a, S>
Create a builder to help you perform the following task:
Lists the health datasets in the current project.
§Arguments
parent
- Required. The name of the project whose datasets should be listed. For example,projects/{project_id}/locations/{location_id}
.
sourcepub fn locations_datasets_patch(
&self,
request: Dataset,
name: &str
) -> ProjectLocationDatasetPatchCall<'a, S>
pub fn locations_datasets_patch( &self, request: Dataset, name: &str ) -> ProjectLocationDatasetPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates dataset metadata.
§Arguments
request
- No description provided.name
- Identifier. Resource name of the dataset, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}
.
sourcepub fn locations_datasets_set_iam_policy(
&self,
request: SetIamPolicyRequest,
resource: &str
) -> ProjectLocationDatasetSetIamPolicyCall<'a, S>
pub fn locations_datasets_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationDatasetSetIamPolicyCall<'a, S>
Create a builder to help you perform the following task:
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
sourcepub fn locations_datasets_test_iam_permissions(
&self,
request: TestIamPermissionsRequest,
resource: &str
) -> ProjectLocationDatasetTestIamPermissionCall<'a, S>
pub fn locations_datasets_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationDatasetTestIamPermissionCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.resource
- REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
sourcepub fn locations_services_nlp_analyze_entities(
&self,
request: AnalyzeEntitiesRequest,
nlp_service: &str
) -> ProjectLocationServiceNlpAnalyzeEntityCall<'a, S>
pub fn locations_services_nlp_analyze_entities( &self, request: AnalyzeEntitiesRequest, nlp_service: &str ) -> ProjectLocationServiceNlpAnalyzeEntityCall<'a, S>
Create a builder to help you perform the following task:
Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aware models to detect entities. This method can only analyze documents written in English.
§Arguments
request
- No description provided.nlpService
- The resource name of the service of the form: “projects/{project_id}/locations/{location_id}/services/nlp”.
sourcepub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, S>
pub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, S>
Create a builder to help you perform the following task:
Gets information about a location.
§Arguments
name
- Resource name for the location.
sourcepub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, S>
pub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, S>
Create a builder to help you perform the following task:
Lists information about the supported locations for this service.
§Arguments
name
- The resource that owns the locations collection, if applicable.