Google_Service_Storagetransfer_TransferOperations_Resource Class Reference

The "transferOperations" collection of methods. More...

Inheritance diagram for Google_Service_Storagetransfer_TransferOperations_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	cancel ($name, $optParams=array())
	Cancels a transfer.
	delete ($name, $optParams=array())
	This method is not supported and the server returns UNIMPLEMENTED.
	get ($name, $optParams=array())
	Gets the latest state of a long-running operation.
	listTransferOperations ($name, $optParams=array())
	Lists operations that match the specified filter in the request.
	pause ($name, Google_Service_Storagetransfer_PauseTransferOperationRequest $postBody, $optParams=array())
	Pauses a transfer operation.
	resume ($name, Google_Service_Storagetransfer_ResumeTransferOperationRequest $postBody, $optParams=array())
	Resumes a transfer operation that is paused.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "transferOperations" collection of methods.

Typical usage is: $storagetransferService = new Google_Service_Storagetransfer(...); $transferOperations = $storagetransferService->transferOperations;

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

cancel()

Google_Service_Storagetransfer_TransferOperations_Resource::cancel	(		$name,
			$optParams = array() )

Cancels a transfer.

Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation. (transferOperations.cancel)

Parameters

string	$name	The name of the operation resource to be cancelled.
array	$optParams	Optional parameters.

Return values

Google_Service_Storagetransfer_Empty

delete()

Google_Service_Storagetransfer_TransferOperations_Resource::delete	(		$name,
			$optParams = array() )

This method is not supported and the server returns UNIMPLEMENTED.

(transferOperations.delete)

Parameters

string	$name	The name of the operation resource to be deleted.
array	$optParams	Optional parameters.

Return values

Google_Service_Storagetransfer_Empty

get()

Google_Service_Storagetransfer_TransferOperations_Resource::get	(		$name,
			$optParams = array() )

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. (transferOperations.get)

Parameters

string	$name	The name of the operation resource.
array	$optParams	Optional parameters.

Return values

Google_Service_Storagetransfer_Operation

listTransferOperations()

Google_Service_Storagetransfer_TransferOperations_Resource::listTransferOperations	(		$name,
			$optParams = array() )

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 below allows API services to override the binding to use different resource name schemes, such as users/operations. (transferOperations.listTransferOperations)

Parameters

string	$name	The value transferOperations.
array	$optParams	Optional parameters.

@opt_param string filter The standard list filter. @opt_param string pageToken The standard list page token. @opt_param int pageSize The standard list page size.

Return values

Google_Service_Storagetransfer_ListOperationsResponse

pause()

Google_Service_Storagetransfer_TransferOperations_Resource::pause	(		$name,
		Google_Service_Storagetransfer_PauseTransferOperationRequest	$postBody,
			$optParams = array() )

Pauses a transfer operation.

(transferOperations.pause)

Parameters

string	$name	The name of the transfer operation. Required.
Google_PauseTransferOperationRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Storagetransfer_Empty

resume()

Google_Service_Storagetransfer_TransferOperations_Resource::resume	(		$name,
		Google_Service_Storagetransfer_ResumeTransferOperationRequest	$postBody,
			$optParams = array() )

Resumes a transfer operation that is paused.

(transferOperations.resume)

Parameters

string	$name	The name of the transfer operation. Required.
Google_ResumeTransferOperationRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Storagetransfer_Empty

---

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

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