Documentation

Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsHl7V2Stores extends Google_Service_Resource
in package

The "hl7V2Stores" collection of methods.

Typical usage is: $healthcareService = new Google_Service_CloudHealthcare(...); $hl7V2Stores = $healthcareService->hl7V2Stores;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_CloudHealthcare_Hl7V2Store
Creates a new HL7v2 store within the parent dataset. (hl7V2Stores.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudHealthcare_HealthcareEmpty
Deletes the specified HL7v2 store and removes all messages that it contains.
get()  : Google_Service_CloudHealthcare_Hl7V2Store
Gets the specified HL7v2 store. (hl7V2Stores.get)
getIamPolicy()  : Google_Service_CloudHealthcare_Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (hl7V2Stores.getIamPolicy)
listProjectsLocationsDatasetsHl7V2Stores()  : Google_Service_CloudHealthcare_ListHl7V2StoresResponse
Lists the HL7v2 stores in the given dataset.
patch()  : Google_Service_CloudHealthcare_Hl7V2Store
Updates the HL7v2 store. (hl7V2Stores.patch)
setIamPolicy()  : Google_Service_CloudHealthcare_Policy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (hl7V2Stores.setIamPolicy)
testIamPermissions()  : Google_Service_CloudHealthcare_TestIamPermissionsResponse
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.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a new HL7v2 store within the parent dataset. (hl7V2Stores.create)

public create(string $parent, Google_Service_CloudHealthcare_Hl7V2Store $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Hl7V2Store
Parameters
$parent : string

The name of the dataset this HL7v2 store belongs to.

$postBody : Google_Service_CloudHealthcare_Hl7V2Store
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string hl7V2StoreId The ID of the HL7v2 store that is being created. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}.

Return values
Google_Service_CloudHealthcare_Hl7V2Store —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (hl7V2Stores.getIamPolicy)

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies).

Return values
Google_Service_CloudHealthcare_Policy —

listProjectsLocationsDatasetsHl7V2Stores()

Lists the HL7v2 stores in the given dataset.

public listProjectsLocationsDatasetsHl7V2Stores(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_ListHl7V2StoresResponse

(hl7V2Stores.listProjectsLocationsDatasetsHl7V2Stores)

Parameters
$parent : string

Name of the dataset.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_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.

opt_param

string pageToken The next_page_token value returned from the previous List request, if any.

opt_param

int pageSize Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used.

Return values
Google_Service_CloudHealthcare_ListHl7V2StoresResponse —

patch()

Updates the HL7v2 store. (hl7V2Stores.patch)

public patch(string $name, Google_Service_CloudHealthcare_Hl7V2Store $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Hl7V2Store
Parameters
$name : string

Resource name of the HL7v2 store, of the form projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}.

$postBody : Google_Service_CloudHealthcare_Hl7V2Store
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#fieldmask

Return values
Google_Service_CloudHealthcare_Hl7V2Store —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (hl7V2Stores.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_CloudHealthcare_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_CloudHealthcare_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudHealthcare_Policy —

testIamPermissions()

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.

public testIamPermissions(string $resource, Google_Service_CloudHealthcare_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_TestIamPermissionsResponse

This operation may "fail open" without warning. (hl7V2Stores.testIamPermissions)

Parameters
$resource : string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_CloudHealthcare_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudHealthcare_TestIamPermissionsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results