Documentation

Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasets extends Google_Service_Resource
in package

Application

The "datasets" collection of methods.

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

$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_Operation: 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.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
deidentify() : Google_Service_CloudHealthcare_Operation: Creates a new dataset containing de-identified data from the source dataset.
delete() : Google_Service_CloudHealthcare_HealthcareEmpty: Deletes the specified health dataset and all data contained in the dataset.
get() : Google_Service_CloudHealthcare_Dataset: Gets any metadata associated with a dataset. (datasets.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. (datasets.getIamPolicy)
listProjectsLocationsDatasets() : Google_Service_CloudHealthcare_ListDatasetsResponse: Lists the health datasets in the current project.
patch() : Google_Service_CloudHealthcare_Dataset: Updates dataset metadata. (datasets.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. (datasets.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

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

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.


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

(datasets.create)

Parameters

$parent : string: The name of the project where the server creates the dataset. For example, projects/{project_id}/locations/{location_id}.
$postBody : Google_Service_CloudHealthcare_Dataset
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

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>

Return values

string —

$requestUrl

deidentify()

Creates a new dataset containing de-identified data from the source dataset.


    public
                deidentify(string $sourceDataset, Google_Service_CloudHealthcare_DeidentifyDatasetRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Operation

The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see Viewing logs. (datasets.deidentify)

Parameters

$sourceDataset : string: Source dataset resource name. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.
$postBody : Google_Service_CloudHealthcare_DeidentifyDatasetRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

delete()

Deletes the specified health dataset and all data contained in the dataset.


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HealthcareEmpty

Deleting a dataset does not affect the sources from which the dataset was imported (if any). (datasets.delete)

Parameters

$name : string: The name of the dataset to delete. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HealthcareEmpty —

get()

Gets any metadata associated with a dataset. (datasets.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Dataset

Parameters

$name : string: The name of the dataset to read. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Dataset —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (datasets.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.

Return values

Google_Service_CloudHealthcare_Policy —

listProjectsLocationsDatasets()

Lists the health datasets in the current project.


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

(datasets.listProjectsLocationsDatasets)

Parameters

$parent : string: The name of the project whose datasets should be listed. For example, projects/{project_id}/locations/{location_id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_ListDatasetsResponse —

patch()

Updates dataset metadata. (datasets.patch)


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

Parameters

$name : string: Resource name of the dataset, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.
$postBody : Google_Service_CloudHealthcare_Dataset
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Dataset —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (datasets.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. (datasets.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 —