3954 lines
246 KiB
Ruby
3954 lines
246 KiB
Ruby
# Copyright 2015 Google Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
require 'google/apis/core/base_service'
|
|
require 'google/apis/core/json_representation'
|
|
require 'google/apis/core/hashable'
|
|
require 'google/apis/errors'
|
|
|
|
module Google
|
|
module Apis
|
|
module HealthcareV1alpha2
|
|
# Cloud Healthcare API
|
|
#
|
|
# Manage, store, and access healthcare data in Google Cloud Platform.
|
|
#
|
|
# @example
|
|
# require 'google/apis/healthcare_v1alpha2'
|
|
#
|
|
# Healthcare = Google::Apis::HealthcareV1alpha2 # Alias the module
|
|
# service = Healthcare::CloudHealthcareService.new
|
|
#
|
|
# @see https://cloud.google.com/healthcare
|
|
class CloudHealthcareService < Google::Apis::Core::BaseService
|
|
# @return [String]
|
|
# API key. Your API key identifies your project and provides you with API access,
|
|
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
|
attr_accessor :key
|
|
|
|
# @return [String]
|
|
# 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.
|
|
attr_accessor :quota_user
|
|
|
|
def initialize
|
|
super('https://healthcare.googleapis.com/', '')
|
|
@batch_path = 'batch'
|
|
end
|
|
|
|
# Gets information about a location.
|
|
# @param [String] name
|
|
# Resource name for the location.
|
|
# @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::HealthcareV1alpha2::Location] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Location]
|
|
#
|
|
# @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(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Location::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Location
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Lists information about the supported locations for this service.
|
|
# @param [String] name
|
|
# The resource that owns the locations collection, if applicable.
|
|
# @param [String] filter
|
|
# The standard list filter.
|
|
# @param [Fixnum] page_size
|
|
# The standard list page size.
|
|
# @param [String] page_token
|
|
# The standard list page token.
|
|
# @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::HealthcareV1alpha2::ListLocationsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListLocationsResponse]
|
|
#
|
|
# @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 list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}/locations', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListLocationsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListLocationsResponse
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.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 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.
|
|
# A Google Cloud Platform project can contain up to 500 datasets across all
|
|
# regions.
|
|
# @param [String] parent
|
|
# The name of the project in which the dataset should be created (e.g.,
|
|
# `projects/`project_id`/locations/`location_id``).
|
|
# @param [Google::Apis::HealthcareV1alpha2::Dataset] dataset_object
|
|
# @param [String] dataset_id
|
|
# The ID of the dataset that is being created.
|
|
# The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
|
|
# @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::HealthcareV1alpha2::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Operation]
|
|
#
|
|
# @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 create_project_location_dataset(parent, dataset_object = nil, dataset_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/datasets', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation
|
|
command.request_object = dataset_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Operation
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['datasetId'] = dataset_id unless dataset_id.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 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.
|
|
# If errors occur,
|
|
# details field type is
|
|
# DeidentifyErrorDetails.
|
|
# @param [String] source_dataset
|
|
# Source dataset resource name. (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``).
|
|
# @param [Google::Apis::HealthcareV1alpha2::DeidentifyDatasetRequest] deidentify_dataset_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::HealthcareV1alpha2::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Operation]
|
|
#
|
|
# @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 deidentify_dataset(source_dataset, deidentify_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+sourceDataset}:deidentify', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::DeidentifyDatasetRequest::Representation
|
|
command.request_object = deidentify_dataset_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Operation
|
|
command.params['sourceDataset'] = source_dataset unless source_dataset.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# 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).
|
|
# @param [String] name
|
|
# The name of the dataset to delete (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``).
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Gets any metadata associated with a dataset.
|
|
# @param [String] name
|
|
# The name of the dataset to read (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``).
|
|
# @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::HealthcareV1alpha2::Dataset] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Dataset]
|
|
#
|
|
# @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(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Dataset
|
|
command.params['name'] = name unless name.nil?
|
|
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.
|
|
# Acceptable values are 0 and 1.
|
|
# If the value is 0, or the field is omitted, policy format version 1 will be
|
|
# returned.
|
|
# @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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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
|
|
|
|
# Lists the health datasets in the current project.
|
|
# @param [String] parent
|
|
# The name of the project whose datasets should be listed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id``).
|
|
# @param [Fixnum] page_size
|
|
# The maximum number of items to return. Capped to 100 if not specified.
|
|
# May not be larger than 1000.
|
|
# @param [String] page_token
|
|
# The next_page_token value returned from a previous List request, if any.
|
|
# @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::HealthcareV1alpha2::ListDatasetsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListDatasetsResponse]
|
|
#
|
|
# @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 list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/datasets', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListDatasetsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListDatasetsResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.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 dataset metadata.
|
|
# @param [String] name
|
|
# Output only. Resource name of the dataset, of the form
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``.
|
|
# @param [Google::Apis::HealthcareV1alpha2::Dataset] dataset_object
|
|
# @param [String] update_mask
|
|
# The update mask applies to the resource. For the `FieldMask` definition,
|
|
# see
|
|
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
|
# fieldmask
|
|
# @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::HealthcareV1alpha2::Dataset] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Dataset]
|
|
#
|
|
# @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 patch_project_location_dataset(name, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation
|
|
command.request_object = dataset_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Dataset
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.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.
|
|
# @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::HealthcareV1alpha2::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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
|
|
command.request_object = set_iam_policy_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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::HealthcareV1alpha2::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::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
|
|
command.request_object = test_iam_permissions_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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 Annotation store within the parent dataset.
|
|
# @param [String] parent
|
|
# The name of the dataset this Annotation store belongs to.
|
|
# @param [Google::Apis::HealthcareV1alpha2::AnnotationStore] annotation_store_object
|
|
# @param [String] annotation_store_id
|
|
# The ID of the Annotation store that is being created.
|
|
# The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
|
|
# @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::HealthcareV1alpha2::AnnotationStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::AnnotationStore]
|
|
#
|
|
# @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 create_project_location_dataset_annotation_store(parent, annotation_store_object = nil, annotation_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/annotationStores', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
|
|
command.request_object = annotation_store_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['annotationStoreId'] = annotation_store_id unless annotation_store_id.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Deletes the specified Annotation store and removes all annotations that are
|
|
# contained within it.
|
|
# @param [String] name
|
|
# The resource name of the Annotation store to delete.
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['name'] = name unless name.nil?
|
|
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 specified Annotation store or returns NOT_FOUND if it does not
|
|
# exist.
|
|
# @param [String] name
|
|
# The resource name of the Annotation store to get.
|
|
# @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::HealthcareV1alpha2::AnnotationStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::AnnotationStore]
|
|
#
|
|
# @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_annotation_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore
|
|
command.params['name'] = name unless name.nil?
|
|
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 NOT_FOUND error if
|
|
# the resource does not exist. Returns an empty policy if the resource exists
|
|
# but does not have a policy set.
|
|
# Authorization requires the Google IAM permission
|
|
# `healthcare.AnnotationStores.getIamPolicy` on the specified
|
|
# resource
|
|
# @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 [Google::Apis::HealthcareV1alpha2::GetIamPolicyRequest] get_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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_annotation_store_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:getIamPolicy', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::GetIamPolicyRequest::Representation
|
|
command.request_object = get_iam_policy_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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
|
|
|
|
# Lists the Annotation stores in the given dataset for a source store.
|
|
# @param [String] parent
|
|
# Name of the dataset.
|
|
# @param [String] filter
|
|
# Restricts stores returned to those matching a filter. Syntax:
|
|
# https://cloud.google.com/appengine/docs/standard/python/search/query_strings
|
|
# Only filtering on labels is supported, for example `labels.key=value`.
|
|
# @param [Fixnum] page_size
|
|
# Limit on the number of Annotation stores to return in a single response.
|
|
# If zero the default page size of 100 is used.
|
|
# @param [String] page_token
|
|
# The next_page_token value returned from the previous List request, if any.
|
|
# @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::HealthcareV1alpha2::ListAnnotationStoresResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse]
|
|
#
|
|
# @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 list_project_location_dataset_annotation_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/annotationStores', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.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 specified Annotation store.
|
|
# @param [String] name
|
|
# Output only. Resource name of the Annotation store, of the form
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# annotationStores/`annotation_store_id``.
|
|
# @param [Google::Apis::HealthcareV1alpha2::AnnotationStore] annotation_store_object
|
|
# @param [String] update_mask
|
|
# The update mask applies to the resource. For the `FieldMask` definition,
|
|
# see
|
|
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
|
# fieldmask
|
|
# @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::HealthcareV1alpha2::AnnotationStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::AnnotationStore]
|
|
#
|
|
# @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 patch_project_location_dataset_annotation_store(name, annotation_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
|
|
command.request_object = annotation_store_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# POLICIES
|
|
# Sets the access control policy for a resource. Replaces any existing
|
|
# policy.
|
|
# Authorization requires the Google IAM permission
|
|
# `healthcare.annotationStores.setIamPolicy` on the specified
|
|
# resource
|
|
# @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::HealthcareV1alpha2::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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_annotation_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
|
|
command.request_object = set_iam_policy_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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.
|
|
# There is no permission required to make this API call.
|
|
# @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::HealthcareV1alpha2::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::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_annotation_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
|
|
command.request_object = test_iam_permissions_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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 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.
|
|
# @param [String] parent
|
|
# The name of the Annotation store this annotation belongs to. For example,
|
|
# `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/
|
|
# myannotationstore`.
|
|
# @param [Google::Apis::HealthcareV1alpha2::Annotation] annotation_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::HealthcareV1alpha2::Annotation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Annotation]
|
|
#
|
|
# @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 create_project_location_dataset_annotation_store_annotation(parent, annotation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/annotations', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
|
|
command.request_object = annotation_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Annotation
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Deletes an Annotation or returns
|
|
# NOT_FOUND if it does not exist.
|
|
# @param [String] name
|
|
# The resource name of the Annotation to delete.
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Gets an Annotation.
|
|
# @param [String] name
|
|
# The resource name of the Annotation to retrieve.
|
|
# @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::HealthcareV1alpha2::Annotation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Annotation]
|
|
#
|
|
# @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_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Annotation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Lists the Annotations in the given
|
|
# Annotation store for a source
|
|
# resource.
|
|
# @param [String] parent
|
|
# Name of the Annotation store to retrieve Annotations from.
|
|
# @param [String] filter
|
|
# Restricts Annotations returned to those matching a filter. Syntax:
|
|
# https://cloud.google.com/appengine/docs/standard/python/search/query_strings
|
|
# Fields/functions available for filtering are:
|
|
# - source_version
|
|
# @param [Fixnum] page_size
|
|
# Limit on the number of Annotations to return in a single response.
|
|
# If zero the default page size of 100 is used.
|
|
# @param [String] page_token
|
|
# The next_page_token value returned from the previous List request, if any.
|
|
# @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::HealthcareV1alpha2::ListAnnotationsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse]
|
|
#
|
|
# @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 list_project_location_dataset_annotation_store_annotations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/annotations', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.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 Annotation.
|
|
# @param [String] name
|
|
# Output only. Resource name of the Annotation, of the form
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# annotationStores/`annotation_store_id`/annotations/`annotation_id``.
|
|
# @param [Google::Apis::HealthcareV1alpha2::Annotation] annotation_object
|
|
# @param [String] update_mask
|
|
# The update mask applies to the resource. For the `FieldMask` definition,
|
|
# see
|
|
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
|
# fieldmask
|
|
# @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::HealthcareV1alpha2::Annotation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Annotation]
|
|
#
|
|
# @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 patch_project_location_dataset_annotation_store_annotation(name, annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
|
|
command.request_object = annotation_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Annotation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.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::HealthcareV1alpha2::DicomStore] dicom_store_object
|
|
# @param [String] dicom_store_id
|
|
# The ID of the DICOM store that is being created.
|
|
# Any string value up to 256 characters in length.
|
|
# @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::HealthcareV1alpha2::DicomStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::DicomStore]
|
|
#
|
|
# @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 create_project_location_dataset_dicom_store(parent, dicom_store_object = nil, dicom_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomStores', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
|
|
command.request_object = dicom_store_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['dicomStoreId'] = dicom_store_id unless dicom_store_id.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Deletes the specified DICOM store and removes all images that are contained
|
|
# within it.
|
|
# @param [String] name
|
|
# The resource name of the DICOM store to delete.
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Exports data to the specified destination by copying it from the DICOM
|
|
# store.
|
|
# The metadata field type is
|
|
# OperationMetadata.
|
|
# @param [String] name
|
|
# The DICOM store resource name from which the data should be exported (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [Google::Apis::HealthcareV1alpha2::ExportDicomDataRequest] export_dicom_data_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::HealthcareV1alpha2::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Operation]
|
|
#
|
|
# @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 export_dicom_store_dicom_data(name, export_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+name}:export', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::ExportDicomDataRequest::Representation
|
|
command.request_object = export_dicom_data_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
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 specified DICOM store.
|
|
# @param [String] name
|
|
# The resource name of the DICOM store to get.
|
|
# @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::HealthcareV1alpha2::DicomStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::DicomStore]
|
|
#
|
|
# @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_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore
|
|
command.params['name'] = name unless name.nil?
|
|
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.
|
|
# Acceptable values are 0 and 1.
|
|
# If the value is 0, or the field is omitted, policy format version 1 will be
|
|
# returned.
|
|
# @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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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
|
|
|
|
# Imports data into the DICOM store by copying it from the specified source.
|
|
# For errors, the Operation will be populated with error details (in the form
|
|
# of ImportDicomDataErrorDetails in error.details), which will hold
|
|
# finer-grained error information. Errors are also logged to Stackdriver
|
|
# (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)).
|
|
# The metadata field type is
|
|
# OperationMetadata.
|
|
# @param [String] name
|
|
# The name of the DICOM store resource into which the data is imported (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [Google::Apis::HealthcareV1alpha2::ImportDicomDataRequest] import_dicom_data_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::HealthcareV1alpha2::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Operation]
|
|
#
|
|
# @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 import_dicom_store_dicom_data(name, import_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+name}:import', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::ImportDicomDataRequest::Representation
|
|
command.request_object = import_dicom_data_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Lists the DICOM stores in the given dataset.
|
|
# @param [String] parent
|
|
# Name of the dataset.
|
|
# @param [String] filter
|
|
# Restricts stores returned to those matching a filter. Syntax:
|
|
# https://cloud.google.com/appengine/docs/standard/python/search/query_strings
|
|
# Only filtering on labels is supported, for example `labels.key=value`.
|
|
# @param [Fixnum] page_size
|
|
# Limit on the number of DICOM stores to return in a single response.
|
|
# If zero the default page size of 100 is used.
|
|
# @param [String] page_token
|
|
# The next_page_token value returned from the previous List request, if any.
|
|
# @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::HealthcareV1alpha2::ListDicomStoresResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse]
|
|
#
|
|
# @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 list_project_location_dataset_dicom_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomStores', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.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 specified DICOM store.
|
|
# @param [String] name
|
|
# Output only. Resource name of the DICOM store, of the form
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``.
|
|
# @param [Google::Apis::HealthcareV1alpha2::DicomStore] dicom_store_object
|
|
# @param [String] update_mask
|
|
# The update mask applies to the resource. For the `FieldMask` definition,
|
|
# see
|
|
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
|
# fieldmask
|
|
# @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::HealthcareV1alpha2::DicomStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::DicomStore]
|
|
#
|
|
# @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 patch_project_location_dataset_dicom_store(name, dicom_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
|
|
command.request_object = dicom_store_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.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.
|
|
# @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::HealthcareV1alpha2::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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
|
|
command.request_object = set_iam_policy_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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::HealthcareV1alpha2::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::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
|
|
command.request_object = test_iam_permissions_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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
|
|
|
|
# SearchForInstances returns a list of matching instances. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the SearchForInstancesRequest DICOMweb request (e.g.,
|
|
# `instances` or `series/`series_uid`/instances` or
|
|
# `studies/`study_uid`/instances`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_dicom_web_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# SearchForSeries returns a list of matching series. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the SearchForSeries DICOMweb request(e.g., `series` or
|
|
# `studies/`study_uid`/series`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_dicom_web_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# SearchForStudies returns a list of matching studies. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the SearchForStudies DICOMweb request (e.g., `studies`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_dicom_web_for_studies(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# StoreInstances stores DICOM instances associated with study instance unique
|
|
# identifiers (SUID). See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the StoreInstances DICOMweb request (e.g.,
|
|
# `studies/[`study_id`]`). Note that the `study_uid` is optional.
|
|
# @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 store_project_location_dataset_dicom_store_dicom_web_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.request_object = http_body_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# DeleteStudy deletes all instances within the given study. Delete requests
|
|
# are equivalent to the GET requests specified in the WADO-RS standard.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the DeleteStudy request (e.g., `studies/`study_id``).
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_dicom_store_dicom_web_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveStudyMetadata returns instance associated with the given study
|
|
# presented as metadata with the bulk data removed. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveStudyMetadata DICOMweb request (e.g.,
|
|
# `studies/`study_id`/metadata`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 metadata_project_location_dataset_dicom_store_dicom_web_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveStudy returns all instances within the given study. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveStudy DICOMweb request (e.g.,
|
|
# `studies/`study_id``).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 retrieve_project_location_dataset_dicom_store_dicom_web_study_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# SearchForInstances returns a list of matching instances. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the SearchForInstancesRequest DICOMweb request (e.g.,
|
|
# `instances` or `series/`series_uid`/instances` or
|
|
# `studies/`study_uid`/instances`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_dicom_web_study_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# SearchForSeries returns a list of matching series. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the SearchForSeries DICOMweb request(e.g., `series` or
|
|
# `studies/`study_uid`/series`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_dicom_web_study_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# StoreInstances stores DICOM instances associated with study instance unique
|
|
# identifiers (SUID). See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the StoreInstances DICOMweb request (e.g.,
|
|
# `studies/[`study_id`]`). Note that the `study_uid` is optional.
|
|
# @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 store_project_location_dataset_dicom_store_dicom_web_study_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.request_object = http_body_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# DeleteSeries deletes all instances within the given study and series.
|
|
# Delete requests are equivalent to the GET requests specified in the WADO-RS
|
|
# standard.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the DeleteSeries request (e.g.,
|
|
# `studies/`study_id`/series/`series_id``).
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_dicom_store_dicom_web_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveSeriesMetadata returns instance associated with the given study and
|
|
# series, presented as metadata with the bulk data removed. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveSeriesMetadata DICOMweb request (e.g.,
|
|
# `studies/`study_id`/series/`series_id`/metadata`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 metadata_project_location_dataset_dicom_store_dicom_web_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveSeries returns all instances within the given study and series. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveSeries DICOMweb request (e.g.,
|
|
# `studies/`study_id`/series/`series_id``).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 retrieve_project_location_dataset_dicom_store_dicom_web_study_series_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# SearchForInstances returns a list of matching instances. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the SearchForInstancesRequest DICOMweb request (e.g.,
|
|
# `instances` or `series/`series_uid`/instances` or
|
|
# `studies/`study_uid`/instances`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_dicom_store_dicom_web_study_series_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# 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 WADO-RS standard.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the DeleteInstance request (e.g.,
|
|
# `studies/`study_id`/series/`series_id`/instances/`instance_id``).
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveInstanceMetadata returns instance associated with the given study,
|
|
# series, and SOP Instance UID presented as metadata with the bulk data
|
|
# removed. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveInstanceMetadata DICOMweb request (e.g.,
|
|
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/metadata`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 metadata_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveRenderedInstance returns instance associated with the given study,
|
|
# series, and SOP Instance UID in an acceptable Rendered Media Type. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveRenderedInstance DICOMweb request (e.g.,
|
|
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/rendered`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 rendered_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveInstance returns instance associated with the given study, series,
|
|
# and SOP Instance UID. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveInstance DICOMweb request (e.g.,
|
|
# `studies/`study_id`/series/`series_id`/instances/`instance_id``).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 retrieve_project_location_dataset_dicom_store_dicom_web_study_series_instance_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveRenderedFrames returns instances associated with the given study,
|
|
# series, SOP Instance UID and frame numbers in an acceptable Rendered Media
|
|
# Type. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveRenderedFrames DICOMweb request (e.g.,
|
|
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/frames/`
|
|
# frame_list`/rendered`).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 rendered_project_location_dataset_dicom_store_dicom_web_study_series_instance_frame(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# RetrieveFrames returns instances associated with the given study, series,
|
|
# SOP Instance UID and frame numbers. See
|
|
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
|
|
# @param [String] parent
|
|
# The name of the DICOM store that is being accessed (e.g.,
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# dicomStores/`dicom_store_id``).
|
|
# @param [String] dicom_web_path
|
|
# The path of the RetrieveFrames DICOMweb request (e.g.,
|
|
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/frames/`
|
|
# frame_list``).
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 retrieve_project_location_dataset_dicom_store_dicom_web_study_series_instance_frame_frames(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
|
|
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 FHIR [capability
|
|
# statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.
|
|
# html)
|
|
# for the store, which contains a description of functionality supported by
|
|
# the server.
|
|
# Implements the FHIR standard [capabilities
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#
|
|
# capabilities).
|
|
# On success, the response body will contain a JSON-encoded representation
|
|
# of a `CapabilityStatement` resource.
|
|
# @param [String] name
|
|
# Name of the FHIR store to retrieve the capabilities for.
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 capabilities_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}/metadata', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.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 FHIR store within the parent dataset.
|
|
# @param [String] parent
|
|
# The name of the dataset this FHIR store belongs to.
|
|
# @param [Google::Apis::HealthcareV1alpha2::FhirStore] fhir_store_object
|
|
# @param [String] fhir_store_id
|
|
# The ID of the FHIR store that is being created.
|
|
# The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
|
|
# @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::HealthcareV1alpha2::FhirStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::FhirStore]
|
|
#
|
|
# @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 create_project_location_dataset_fhir_store(parent, fhir_store_object = nil, fhir_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/fhirStores', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
|
|
command.request_object = fhir_store_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['fhirStoreId'] = fhir_store_id unless fhir_store_id.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Deletes the specified FHIR store and removes all resources within it.
|
|
# @param [String] name
|
|
# The resource name of the FHIR store to delete.
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# 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.
|
|
# 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.
|
|
# @param [String] name
|
|
# The name of the FHIR store to export resource from. The name should be in
|
|
# the format of
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# fhirStores/`fhir_store_id``.
|
|
# @param [Google::Apis::HealthcareV1alpha2::ExportResourcesRequest] export_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::HealthcareV1alpha2::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Operation]
|
|
#
|
|
# @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 export_fhir_store_resources(name, export_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+name}:export', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::ExportResourcesRequest::Representation
|
|
command.request_object = export_resources_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
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 configuration of the specified FHIR store.
|
|
# @param [String] name
|
|
# The resource name of the FHIR store to get.
|
|
# @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::HealthcareV1alpha2::FhirStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::FhirStore]
|
|
#
|
|
# @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_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore
|
|
command.params['name'] = name unless name.nil?
|
|
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.
|
|
# Acceptable values are 0 and 1.
|
|
# If the value is 0, or the field is omitted, policy format version 1 will be
|
|
# returned.
|
|
# @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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_fhir_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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
|
|
|
|
# Import resources to the FHIR store by loading data from the specified
|
|
# sources. Each resource must have a client-supplied ID, which is retained
|
|
# by the server.
|
|
# The import operation is idempotent. Upon retry, the most recent data
|
|
# (matching the client-supplied ID) is overwritten, without creating a new
|
|
# resource version. If partial failures occur during the import, successful
|
|
# changes are not rolled back.
|
|
# If history imports are enabled
|
|
# (enable_history_import is set in the
|
|
# FHIR store's configuration), you can import historical versions of a
|
|
# resource by supplying a bundle of type `history`. The historical versions
|
|
# in the bundle must have `lastUpdated` timestamps. If a current or
|
|
# historical version with the supplied resource ID already exists, the
|
|
# bundle is rejected.
|
|
# 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.
|
|
# 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.
|
|
# @param [String] name
|
|
# The name of the FHIR store to import FHIR resources to. The name should be
|
|
# in the format of
|
|
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
|
# fhirStores/`fhir_store_id``.
|
|
# @param [Google::Apis::HealthcareV1alpha2::ImportResourcesRequest] import_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::HealthcareV1alpha2::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Operation]
|
|
#
|
|
# @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 import_fhir_store_resources(name, import_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+name}:import', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::ImportResourcesRequest::Representation
|
|
command.request_object = import_resources_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Lists the FHIR stores in the given dataset.
|
|
# @param [String] parent
|
|
# Name of the dataset.
|
|
# @param [String] filter
|
|
# Restricts stores returned to those matching a filter. Syntax:
|
|
# https://cloud.google.com/appengine/docs/standard/python/search/query_strings
|
|
# Only filtering on labels is supported, for example `labels.key=value`.
|
|
# @param [Fixnum] page_size
|
|
# Limit on the number of FHIR stores to return in a single response. If zero
|
|
# the default page size of 100 is used.
|
|
# @param [String] page_token
|
|
# The next_page_token value returned from the previous List request, if any.
|
|
# @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::HealthcareV1alpha2::ListFhirStoresResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse]
|
|
#
|
|
# @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 list_project_location_dataset_fhir_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/fhirStores', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.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 configuration of the specified FHIR store.
|
|
# @param [String] name
|
|
# Output only. Resource name of the FHIR store, of the form
|
|
# `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
|
|
# @param [Google::Apis::HealthcareV1alpha2::FhirStore] fhir_store_object
|
|
# @param [String] update_mask
|
|
# The update mask applies to the resource. For the `FieldMask` definition,
|
|
# see
|
|
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
|
# fieldmask
|
|
# @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::HealthcareV1alpha2::FhirStore] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::FhirStore]
|
|
#
|
|
# @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 patch_project_location_dataset_fhir_store(name, fhir_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
|
|
command.request_object = fhir_store_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.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.
|
|
# @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::HealthcareV1alpha2::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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_fhir_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
|
|
command.request_object = set_iam_policy_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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::HealthcareV1alpha2::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::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_fhir_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
|
|
command.request_object = test_iam_permissions_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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
|
|
|
|
# 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](http://hl7.org/implement/standards/fhir/STU3/observation-
|
|
# operations.html#lastn).
|
|
# Search terms are provided as query parameters following the same pattern as
|
|
# the search method. 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.
|
|
# On success, the response body will contain a JSON-encoded representation
|
|
# of a `Bundle` resource of type `searchset`, containing the results of the
|
|
# operation.
|
|
# 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.
|
|
# @param [String] parent
|
|
# Name of the FHIR store to retrieve resources from.
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 observation_project_location_dataset_fhir_store_fhir_lastn(parent, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/fhir/Observation/$lastn', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Retrieves all the resources in the patient compartment for a `Patient`
|
|
# resource.
|
|
# Implements the FHIR extended operation
|
|
# [Patient-everything](http://hl7.org/implement/standards/fhir/STU3/patient-
|
|
# operations.html#everything).
|
|
# On success, the response body will contain a JSON-encoded representation
|
|
# of a `Bundle` resource of type `searchset`, containing the results of the
|
|
# operation.
|
|
# 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.
|
|
# @param [String] name
|
|
# Name of the `Patient` resource for which the information is required.
|
|
# @param [String] end_
|
|
# The response includes records prior to the end date. If no end date is
|
|
# provided, all records subsequent to the start date are in scope.
|
|
# @param [String] start
|
|
# The response includes records subsequent to the start date. If no start
|
|
# date is provided, all records prior to the end date are in scope.
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 patient_project_location_dataset_fhir_store_fhir_everything(name, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}/$everything', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['end'] = end_ unless end_.nil?
|
|
command.query['start'] = start unless start.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# 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.
|
|
# @param [String] name
|
|
# The name of the resource to purge.
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 resource_project_location_dataset_fhir_store_fhir_purge(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}/$purge', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['name'] = name unless name.nil?
|
|
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 FHIR [capability
|
|
# statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.
|
|
# html)
|
|
# for the store, which contains a description of functionality supported by
|
|
# the server.
|
|
# Implements the FHIR standard [capabilities
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#
|
|
# capabilities).
|
|
# On success, the response body will contain a JSON-encoded representation
|
|
# of a `CapabilityStatement` resource.
|
|
# @param [String] name
|
|
# Name of the FHIR store to retrieve the capabilities for.
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 capabilities_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}/fhir/metadata', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Deletes FHIR resources that match a search query.
|
|
# Implements the FHIR standard [conditional delete
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.
|
|
# 1).
|
|
# If multiple resources match, all of them will be deleted.
|
|
# Search terms are provided as query parameters following the same pattern as
|
|
# the search method.
|
|
# Note: Unless resource versioning is disabled by setting the
|
|
# disable_resource_versioning flag
|
|
# on the FHIR store, the deleted resources will be moved to a history
|
|
# repository that can still be retrieved through vread
|
|
# and related methods, unless they are removed by the
|
|
# purge method.
|
|
# @param [String] parent
|
|
# The name of the FHIR store this resource belongs to.
|
|
# @param [String] type
|
|
# The FHIR resource type to delete, such as Patient or Observation. For a
|
|
# complete list, see the [FHIR Resource
|
|
# Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html).
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 conditional_project_location_dataset_fhir_store_fhir_delete(parent, type, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+parent}/fhir/{+type}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['type'] = type unless 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
|
|
|
|
# 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](http://jsonpatch.com/) document.
|
|
# Implements the FHIR standard [conditional patch
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch).
|
|
# 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 will
|
|
# return 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 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.
|
|
# @param [String] parent
|
|
# The name of the FHIR store this resource belongs to.
|
|
# @param [String] type
|
|
# The FHIR resource type to update, such as Patient or Observation. For a
|
|
# complete list, see the [FHIR Resource
|
|
# Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html).
|
|
# @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 conditional_project_location_dataset_fhir_store_fhir_patch(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+parent}/fhir/{+type}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.request_object = http_body_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['type'] = type unless 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
|
|
|
|
# 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](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-
|
|
# update).
|
|
# 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 will
|
|
# return 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. If the search criteria identify zero
|
|
# matches, and the supplied resource body does not contain an `id`, the
|
|
# resource will be 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 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.
|
|
# @param [String] parent
|
|
# The name of the FHIR store this resource belongs to.
|
|
# @param [String] type
|
|
# The FHIR resource type to update, such as Patient or Observation. For a
|
|
# complete list, see the [FHIR Resource
|
|
# Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html).
|
|
# Must match the resource type in the provided content.
|
|
# @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 conditional_project_location_dataset_fhir_store_fhir_update(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:put, 'v1alpha2/{+parent}/fhir/{+type}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.request_object = http_body_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['type'] = type unless 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
|
|
|
|
# Creates a FHIR resource.
|
|
# Implements the FHIR standard [create
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#create),
|
|
# which creates a new resource with a server-assigned resource ID.
|
|
# Also supports the FHIR standard [conditional create
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate),
|
|
# 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 will contain 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 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.
|
|
# @param [String] parent
|
|
# The name of the FHIR store this resource belongs to.
|
|
# @param [String] type
|
|
# The FHIR resource type to create, such as Patient or Observation. For a
|
|
# complete list, see the [FHIR Resource
|
|
# Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html).
|
|
# Must match the resource type in the provided content.
|
|
# @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 create_project_location_dataset_fhir_store_fhir(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir/{+type}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.request_object = http_body_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.params['type'] = type unless 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
|
|
|
|
# Deletes a FHIR resource.
|
|
# Implements the FHIR standard [delete
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#delete).
|
|
# Note: Unless resource versioning is disabled by setting the
|
|
# disable_resource_versioning flag
|
|
# on the FHIR store, the deleted resources will be moved to a history
|
|
# repository that can still be retrieved through vread
|
|
# and related methods, unless they are removed by the
|
|
# purge method.
|
|
# @param [String] name
|
|
# The name of the resource to delete.
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 delete_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Executes all the requests in the given Bundle.
|
|
# Implements the FHIR standard [batch/transaction
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#
|
|
# transaction).
|
|
# Supports all interactions within a bundle, except search. This method
|
|
# accepts Bundles of type `batch` and `transaction`, processing them
|
|
# according to the [batch processing
|
|
# rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1)
|
|
# and [transaction processing
|
|
# rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2).
|
|
# 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 will
|
|
# contain 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 bundle, the response body 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.
|
|
# @param [String] parent
|
|
# Name of the FHIR store in which this bundle will be executed.
|
|
# @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 execute_project_location_dataset_fhir_store_fhir_bundle(parent, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.request_object = http_body_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# 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](http://hl7.org/implement/standards/fhir/STU3/http.html#history).
|
|
# On success, the response body will contain 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 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.
|
|
# @param [String] name
|
|
# The name of the resource to retrieve.
|
|
# @param [String] at
|
|
# Only include resource versions that were current at some point during the
|
|
# time period specified in the date time value. The date parameter format is
|
|
# yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm]
|
|
# Clients may specify any of the following:
|
|
# * An entire year: `_at=2019`
|
|
# * An entire month: `_at=2019-01`
|
|
# * A specific day: `_at=2019-01-20`
|
|
# * A specific second: `_at=2018-12-31T23:59:58Z`
|
|
# @param [Fixnum] count
|
|
# The maximum number of search results on a page. Defaults to 1000.
|
|
# @param [String] page
|
|
# Used to retrieve the first, previous, next, or last page of resource
|
|
# versions when using pagination. Value should be set to the value of the
|
|
# `link.url` field returned in the response to the previous request, where
|
|
# `link.relation` is "first", "previous", "next" or "last".
|
|
# Omit `page` if no previous request has been made.
|
|
# @param [String] since
|
|
# Only include resource versions that were created at or after the given
|
|
# instant in time. The instant in time uses the format
|
|
# YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or
|
|
# 2017-01-01T00:00:00Z). The time must be specified to the second and
|
|
# include a time zone.
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 history_project_location_dataset_fhir_store_fhir(name, at: nil, count: nil, page: nil, since: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}/_history', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['at'] = at unless at.nil?
|
|
command.query['count'] = count unless count.nil?
|
|
command.query['page'] = page unless page.nil?
|
|
command.query['since'] = since unless since.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 part of an existing resource by applying the operations specified
|
|
# in a [JSON Patch](http://jsonpatch.com/) document.
|
|
# Implements the FHIR standard [patch
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch).
|
|
# 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 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.
|
|
# @param [String] name
|
|
# The name of the resource to update.
|
|
# @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 patch_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.request_object = http_body_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.nil?
|
|
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 contents of a FHIR resource.
|
|
# Implements the FHIR standard [read
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#read).
|
|
# Also supports the FHIR standard [conditional read
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cread)
|
|
# 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 will contain a JSON-encoded representation
|
|
# of the resource.
|
|
# 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.
|
|
# @param [String] name
|
|
# The name of the resource to retrieve.
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 read_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.nil?
|
|
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](http://hl7.org/implement/standards/fhir/STU3/http.html#search)
|
|
# using the search semantics described in the [FHIR Search
|
|
# specification](http://hl7.org/implement/standards/fhir/STU3/search.html).
|
|
# Supports three 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](http://hl7.org/implement/standards/fhir/STU3/searchparameter-
|
|
# registry.html).
|
|
# 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.
|
|
# @param [String] parent
|
|
# Name of the FHIR store to retrieve resources from.
|
|
# @param [Google::Apis::HealthcareV1alpha2::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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_fhir_resources(parent, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir/_search', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::SearchResourcesRequest::Representation
|
|
command.request_object = search_resources_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['parent'] = parent unless parent.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](http://hl7.org/implement/standards/fhir/STU3/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.
|
|
# @param [String] name
|
|
# The name of the resource to update.
|
|
# @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 update_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:put, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.request_object = http_body_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.nil?
|
|
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 contents of a version (current or historical) of a FHIR resource
|
|
# by version ID.
|
|
# Implements the FHIR standard [vread
|
|
# interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#vread).
|
|
# On success, the response body will contain a JSON-encoded representation
|
|
# of the resource.
|
|
# 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.
|
|
# @param [String] name
|
|
# The name of the resource version to retrieve.
|
|
# @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::HealthcareV1alpha2::HttpBody] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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 vread_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody
|
|
command.params['name'] = name unless name.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 HL7v2 store within the parent dataset.
|
|
# @param [String] parent
|
|
# The name of the dataset this HL7v2 store belongs to.
|
|
# @param [Google::Apis::HealthcareV1alpha2::Hl7V2Store] hl7_v2_store_object
|
|
# @param [String] hl7_v2_store_id
|
|
# The ID of the HL7v2 store that is being created.
|
|
# The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
|
|
# @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::HealthcareV1alpha2::Hl7V2Store] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Hl7V2Store]
|
|
#
|
|
# @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 create_project_location_dataset_hl7_v2_store(parent, hl7_v2_store_object = nil, hl7_v2_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/hl7V2Stores', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
|
|
command.request_object = hl7_v2_store_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['hl7V2StoreId'] = hl7_v2_store_id unless hl7_v2_store_id.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Deletes the specified HL7v2 store and removes all messages that are
|
|
# contained within it.
|
|
# @param [String] name
|
|
# The resource name of the HL7v2 store to delete.
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['name'] = name unless name.nil?
|
|
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 specified HL7v2 store.
|
|
# @param [String] name
|
|
# The resource name of the HL7v2 store to get.
|
|
# @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::HealthcareV1alpha2::Hl7V2Store] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Hl7V2Store]
|
|
#
|
|
# @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_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store
|
|
command.params['name'] = name unless name.nil?
|
|
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.
|
|
# Acceptable values are 0 and 1.
|
|
# If the value is 0, or the field is omitted, policy format version 1 will be
|
|
# returned.
|
|
# @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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_hl7_v2_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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
|
|
|
|
# Lists the HL7v2 stores in the given dataset.
|
|
# @param [String] parent
|
|
# Name of the dataset.
|
|
# @param [String] filter
|
|
# Restricts stores returned to those matching a filter. Syntax:
|
|
# https://cloud.google.com/appengine/docs/standard/python/search/query_strings
|
|
# Only filtering on labels is supported, for example `labels.key=value`.
|
|
# @param [Fixnum] page_size
|
|
# Limit on the number of HL7v2 stores to return in a single response.
|
|
# If zero the default page size of 100 is used.
|
|
# @param [String] page_token
|
|
# The next_page_token value returned from the previous List request, if any.
|
|
# @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::HealthcareV1alpha2::ListHl7V2StoresResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse]
|
|
#
|
|
# @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 list_project_location_dataset_hl7_v2_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/hl7V2Stores', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.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 HL7v2 store.
|
|
# @param [String] name
|
|
# Output only. Resource name of the HL7v2 store, of the form
|
|
# `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``.
|
|
# @param [Google::Apis::HealthcareV1alpha2::Hl7V2Store] hl7_v2_store_object
|
|
# @param [String] update_mask
|
|
# The update mask applies to the resource. For the `FieldMask` definition,
|
|
# see
|
|
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
|
# fieldmask
|
|
# @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::HealthcareV1alpha2::Hl7V2Store] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Hl7V2Store]
|
|
#
|
|
# @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 patch_project_location_dataset_hl7_v2_store(name, hl7_v2_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
|
|
command.request_object = hl7_v2_store_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.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.
|
|
# @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::HealthcareV1alpha2::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::HealthcareV1alpha2::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_hl7_v2_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation
|
|
command.request_object = set_iam_policy_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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::HealthcareV1alpha2::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::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::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_hl7_v2_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation
|
|
command.request_object = test_iam_permissions_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::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 message and sends a notification to the Cloud Pub/Sub topic. If
|
|
# configured, the MLLP adapter listens to messages created by this method and
|
|
# sends those back to the hospital. A successful response indicates the
|
|
# message has been persisted to storage and a Cloud Pub/Sub notification has
|
|
# been sent. Sending to the hospital by the MLLP adapter happens
|
|
# asynchronously.
|
|
# @param [String] parent
|
|
# The name of the dataset this message belongs to.
|
|
# @param [Google::Apis::HealthcareV1alpha2::CreateMessageRequest] create_message_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::HealthcareV1alpha2::Message] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Message]
|
|
#
|
|
# @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 create_message(parent, create_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/messages', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::CreateMessageRequest::Representation
|
|
command.request_object = create_message_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Message
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Deletes an HL7v2 message.
|
|
# @param [String] name
|
|
# The resource name of the HL7v2 message to delete.
|
|
# @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::HealthcareV1alpha2::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Empty]
|
|
#
|
|
# @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 delete_project_location_dataset_hl7_v2_store_message(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Empty
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Gets an HL7v2 message.
|
|
# @param [String] name
|
|
# The resource name of the HL7v2 message to retrieve.
|
|
# @param [String] view
|
|
# Specifies which parts of the Message resource should be returned
|
|
# in the response.
|
|
# @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::HealthcareV1alpha2::Message] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Message]
|
|
#
|
|
# @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_hl7_v2_store_message(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Message
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['view'] = view unless view.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Ingests a new HL7v2 message from the hospital and sends a notification to
|
|
# the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was
|
|
# successfully stored. Otherwise an error is returned. If an identical
|
|
# HL7v2 message is created twice only one resource is created on the server
|
|
# and no error is reported.
|
|
# @param [String] parent
|
|
# The name of the HL7v2 store this message belongs to.
|
|
# @param [Google::Apis::HealthcareV1alpha2::IngestMessageRequest] ingest_message_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::HealthcareV1alpha2::IngestMessageResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::IngestMessageResponse]
|
|
#
|
|
# @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 ingest_message(parent, ingest_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1alpha2/{+parent}/messages:ingest', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::IngestMessageRequest::Representation
|
|
command.request_object = ingest_message_request_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::IngestMessageResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::IngestMessageResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# 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.
|
|
# @param [String] parent
|
|
# Name of the HL7v2 store to retrieve messages from.
|
|
# @param [String] filter
|
|
# Restricts messages returned to those matching a filter. Syntax:
|
|
# https://cloud.google.com/appengine/docs/standard/python/search/query_strings
|
|
# Fields/functions available for filtering are:
|
|
# * `message_type`, from the MSH-9 segment; for example
|
|
# `NOT message_type = "ADT"`
|
|
# * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in
|
|
# the dataset's time_zone, from the MSH-7 segment; for example
|
|
# `send_date < "2017-01-02"`
|
|
# * `send_time`, the timestamp when the message was sent, using the
|
|
# RFC3339 time format for comparisons, from the MSH-7 segment; for example
|
|
# `send_time < "2017-01-02T00:00:00-05:00"`
|
|
# * `send_facility`, the care center that the message came from, from the
|
|
# MSH-4 segment; for example `send_facility = "ABC"`
|
|
# * `HL7RegExp(expr)`, which does regular expression matching of `expr`
|
|
# against the message payload using re2 (http://code.google.com/p/re2/)
|
|
# syntax; for example `HL7RegExp("^.*\|.*\|EMERG")`
|
|
# * `PatientId(value, type)`, which matches if the message lists a patient
|
|
# having an ID of the given value and type in the PID-2, PID-3, or PID-4
|
|
# segments; for example `PatientId("123456", "MRN")`
|
|
# * `labels.x`, a string value of the label with key `x` as set using the
|
|
# Message.labels
|
|
# map, for example `labels."priority"="high"`. The operator `:*` can be used
|
|
# to assert the existence of a label, for example `labels."priority":*`.
|
|
# Limitations on conjunctions:
|
|
# * Negation on the patient ID function or the labels field is not
|
|
# supported, for example these queries are invalid:
|
|
# `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`,
|
|
# `NOT labels."tag2"="val2"`.
|
|
# * Conjunction of multiple patient ID functions is not supported, for
|
|
# example this query is invalid:
|
|
# `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`.
|
|
# * Conjunction of multiple labels fields is also not supported, for
|
|
# example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`.
|
|
# * Conjunction of one patient ID function, one labels field and conditions
|
|
# on other fields is supported, for example this query is valid:
|
|
# `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`.
|
|
# The HasLabel(x) and Label(x) syntax from previous API versions are
|
|
# deprecated; replaced by the `labels.x` syntax.
|
|
# @param [String] order_by
|
|
# Orders messages returned by the specified order_by clause.
|
|
# Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order
|
|
# Fields available for ordering are:
|
|
# * `send_time`
|
|
# @param [Fixnum] page_size
|
|
# Limit on the number of messages to return in a single response.
|
|
# If zero the default page size of 100 is used.
|
|
# @param [String] page_token
|
|
# The next_page_token value returned from the previous List request, if any.
|
|
# @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::HealthcareV1alpha2::ListMessagesResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListMessagesResponse]
|
|
#
|
|
# @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 list_project_location_dataset_hl7_v2_store_messages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+parent}/messages', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListMessagesResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListMessagesResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Update the message.
|
|
# @param [String] name
|
|
# Resource name of the Message, of the form
|
|
# `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7_v2_store_id`/
|
|
# messages/`message_id``.
|
|
# Assigned by the server.
|
|
# @param [Google::Apis::HealthcareV1alpha2::Message] message_object
|
|
# @param [String] update_mask
|
|
# The update mask applies to the resource. For the `FieldMask` definition,
|
|
# see
|
|
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
|
# fieldmask
|
|
# Only the `labels` field is allowed to be updated.
|
|
# The labels in the request will be merged with the existing set of labels.
|
|
# Existing labels with the same keys will be updated.
|
|
# @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::HealthcareV1alpha2::Message] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Message]
|
|
#
|
|
# @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 patch_project_location_dataset_hl7_v2_store_message(name, message_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
|
|
command.request_representation = Google::Apis::HealthcareV1alpha2::Message::Representation
|
|
command.request_object = message_object
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Message
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
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 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.
|
|
# @param [String] name
|
|
# The name of the operation resource.
|
|
# @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::HealthcareV1alpha2::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::Operation]
|
|
#
|
|
# @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_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Lists operations that match the specified filter in the request. If the
|
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
# NOTE: the `name` binding allows API services to override the binding
|
|
# to use different resource name schemes, such as `users/*/operations`. To
|
|
# override the binding, API services can add a binding such as
|
|
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
|
# For backwards compatibility, the default name includes the operations
|
|
# collection id, however overriding users must ensure the name binding
|
|
# is the parent resource, without the operations collection id.
|
|
# @param [String] name
|
|
# The name of the operation's parent resource.
|
|
# @param [String] filter
|
|
# The standard list filter.
|
|
# @param [Fixnum] page_size
|
|
# The standard list page size.
|
|
# @param [String] page_token
|
|
# The standard list page token.
|
|
# @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::HealthcareV1alpha2::ListOperationsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::HealthcareV1alpha2::ListOperationsResponse]
|
|
#
|
|
# @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 list_project_location_dataset_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1alpha2/{+name}/operations', options)
|
|
command.response_representation = Google::Apis::HealthcareV1alpha2::ListOperationsResponse::Representation
|
|
command.response_class = Google::Apis::HealthcareV1alpha2::ListOperationsResponse
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
protected
|
|
|
|
def apply_command_defaults(command)
|
|
command.query['key'] = key unless key.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|