lib/google/apis/healthcare_v1/service.rb in google-apis-healthcare_v1-0.1.0 vs lib/google/apis/healthcare_v1/service.rb in google-apis-healthcare_v1-0.2.0

- old
+ new

@@ -453,10 +453,125 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_consent_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_consent_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_consent_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new DICOM store within the parent dataset. # @param [String] parent # The name of the dataset this DICOM store belongs to. # @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object # @param [String] dicom_store_id @@ -1960,11 +2075,15 @@ # 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. The import process does not enforce referential integrity, + # 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 @@ -2659,41 +2778,43 @@ # hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/ # implement/standards/fhir/R4/http.html#search)) using the search semantics # described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/ # standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/ # fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search. - # html)). Supports three methods of search defined by the specification: * `GET [ + # html)). 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]/[type]/ - # _search?[parameters]` as an alternate form having the same semantics as the ` - # GET` method. The `GET` methods do not support compartment searches. The `POST` - # method does not support `application/x-www-form-urlencoded` search parameters. - # On success, the response body will contain a JSON-encoded representation of a ` - # Bundle` resource of type `searchset`, containing the results of the search. - # Errors generated by the FHIR store will 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](http://hl7.org/ - # implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7. - # org/implement/standards/fhir/R4/searchparameter-registry.html)). 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`. 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. If there are additional results, the - # returned `Bundle` will contain pagination links. 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 changes and when the change is - # reflected in search results. For samples and detailed information, see [ - # Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [ + # 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 will contain a JSON-encoded + # representation of a `Bundle` resource of type `searchset`, containing the + # results of the search. Errors generated by the FHIR store will 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](http:/ + # /hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4]( + # http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). + # 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`. + # 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. If there are additional + # results, the returned `Bundle` will contain pagination links. 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 changes and when the + # change is reflected in search results. For samples and detailed information, + # see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [ # Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search). # @param [String] parent # Name of the FHIR store to retrieve resources from. # @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object # @param [String] fields @@ -2723,25 +2844,111 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + # Searches for resources in the given FHIR store according to criteria specified + # as query parameters. Implements the FHIR standard search interaction ([DSTU2]( + # http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http:// + # hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/ + # implement/standards/fhir/R4/http.html#search)) using the search semantics + # described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/ + # standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/ + # fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search. + # html)). 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 will contain a JSON-encoded + # representation of a `Bundle` resource of type `searchset`, containing the + # results of the search. Errors generated by the FHIR store will 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](http:/ + # /hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4]( + # http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). + # 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`. + # 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. If there are additional + # results, the returned `Bundle` will contain pagination links. 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 changes and when the + # change is reflected in search results. For samples and detailed information, + # see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [ + # Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search). + # @param [String] parent + # Name of the FHIR store to retrieve resources from. + # @param [String] resource_type + # The FHIR resource type to search, such as Patient or Observation. For a + # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/ + # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/ + # standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/ + # standards/fhir/R4/resourcelist.html)). + # @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_fhir_store_fhir_type(parent, resource_type, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/fhir/{resourceType}/_search', options) + command.request_representation = Google::Apis::HealthcareV1::SearchResourcesRequest::Representation + command.request_object = search_resources_request_object + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['resourceType'] = resource_type unless resource_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Updates the entire contents of a resource. Implements the FHIR standard update # interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html# # update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the # specified resource does not exist and the FHIR store has enable_update_create - # set, creates the resource with the client-specified ID. 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 will contain a JSON-encoded representation of - # the updated resource, including the server-assigned version ID. Errors - # generated by the FHIR store will 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](/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). + # 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 Cloud 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 will contain a JSON-encoded + # representation of the updated resource, including the server-assigned version + # ID. Errors generated by the FHIR store will 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](/healthcare/docs/how-tos/fhir-resources# + # updating_a_fhir_resource). # @param [String] name # The name of the resource to update. # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response.