Google_Service_Genomics_Datasets_Resource Class Reference

The "datasets" collection of methods. More...

Inheritance diagram for Google_Service_Genomics_Datasets_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create (Google_Service_Genomics_Dataset $postBody, $optParams=array())
	Creates a new dataset.
	delete ($datasetId, $optParams=array())
	Deletes a dataset.
	get ($datasetId, $optParams=array())
	Gets a dataset by ID.
	getIamPolicy ($resource, Google_Service_Genomics_GetIamPolicyRequest $postBody, $optParams=array())
	Gets the access control policy for the dataset.
	listDatasets ($optParams=array())
	Lists datasets within a project.
	patch ($datasetId, Google_Service_Genomics_Dataset $postBody, $optParams=array())
	Updates a dataset.
	setIamPolicy ($resource, Google_Service_Genomics_SetIamPolicyRequest $postBody, $optParams=array())
	Sets the access control policy on the specified dataset.
	testIamPermissions ($resource, Google_Service_Genomics_TestIamPermissionsRequest $postBody, $optParams=array())
	Returns permissions that a caller has on the specified resource.
	undelete ($datasetId, Google_Service_Genomics_UndeleteDatasetRequest $postBody, $optParams=array())
	Undeletes a dataset by restoring a dataset which was deleted via this API.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "datasets" collection of methods.

Typical usage is: $genomicsService = new Google_Service_Genomics(...); $datasets = $genomicsService->datasets;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

create()

Google_Service_Genomics_Datasets_Resource::create	(	Google_Service_Genomics_Dataset	$postBody,
			$optParams = array() )

Creates a new dataset.

(datasets.create)

Parameters

Google_Dataset	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Dataset

delete()

Google_Service_Genomics_Datasets_Resource::delete	(		$datasetId,
			$optParams = array() )

Deletes a dataset.

(datasets.delete)

Parameters

string	$datasetId	The ID of the dataset to be deleted.
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Empty

get()

Google_Service_Genomics_Datasets_Resource::get	(		$datasetId,
			$optParams = array() )

Gets a dataset by ID.

(datasets.get)

Parameters

string	$datasetId	The ID of the dataset.
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Dataset

getIamPolicy()

Google_Service_Genomics_Datasets_Resource::getIamPolicy	(		$resource,
		Google_Service_Genomics_GetIamPolicyRequest	$postBody,
			$optParams = array() )

Gets the access control policy for the dataset.

Is empty if the policy or the resource does not exist. See Getting a Policy for more information. (datasets.getIamPolicy)

Parameters

string	$resource	REQUIRED: The resource for which policy is being specified. Format is datasets/.
Google_GetIamPolicyRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Policy

listDatasets()

Google_Service_Genomics_Datasets_Resource::listDatasets

(

$optParams = array()

)

Lists datasets within a project.

(datasets.listDatasets)

Parameters

array

$optParams

Optional parameters.

@opt_param string projectId Required. The project to list datasets for. @opt_param int pageSize The maximum number of results returned by this request. If unspecified, defaults to 50. The maximum value is 1024. @opt_param string pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

Return values

Google_Service_Genomics_ListDatasetsResponse

patch()

Google_Service_Genomics_Datasets_Resource::patch	(		$datasetId,
		Google_Service_Genomics_Dataset	$postBody,
			$optParams = array() )

Updates a dataset.

This method supports patch semantics. (datasets.patch)

Parameters

string	$datasetId	The ID of the dataset to be updated.
Google_Dataset	$postBody
array	$optParams	Optional parameters.

@opt_param string updateMask An optional mask specifying which fields to update. At this time, the only mutable field is name. The only acceptable value is "name". If unspecified, all mutable fields will be updated.

Return values

Google_Service_Genomics_Dataset

setIamPolicy()

Google_Service_Genomics_Datasets_Resource::setIamPolicy	(		$resource,
		Google_Service_Genomics_SetIamPolicyRequest	$postBody,
			$optParams = array() )

Sets the access control policy on the specified dataset.

Replaces any existing policy. See Setting a Policy for more information. (datasets.setIamPolicy)

Parameters

string	$resource	REQUIRED: The resource for which policy is being specified. Format is datasets/.
Google_SetIamPolicyRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Policy

testIamPermissions()

Google_Service_Genomics_Datasets_Resource::testIamPermissions	(		$resource,
		Google_Service_Genomics_TestIamPermissionsRequest	$postBody,
			$optParams = array() )

Returns permissions that a caller has on the specified resource.

See Testing Permissions for more information. (datasets.testIamPermissions)

Parameters

string	$resource	REQUIRED: The resource for which policy is being specified. Format is datasets/.
Google_TestIamPermissionsRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_TestIamPermissionsResponse

undelete()

Google_Service_Genomics_Datasets_Resource::undelete	(		$datasetId,
		Google_Service_Genomics_UndeleteDatasetRequest	$postBody,
			$optParams = array() )

Undeletes a dataset by restoring a dataset which was deleted via this API.

This operation is only possible for a week after the deletion occurred. (datasets.undelete)

Parameters

string	$datasetId	The ID of the dataset to be undeleted.
Google_UndeleteDatasetRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Dataset

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Genomics.php