Documentation

Google_Service_BigQueryDataTransfer_Resource_ProjectsLocationsTransferConfigsRuns extends Google_Service_Resource
in package

The "runs" collection of methods.

Typical usage is: $bigquerydatatransferService = new Google_Service_BigQueryDataTransfer(...); $runs = $bigquerydatatransferService->runs;

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_BigQueryDataTransfer_BigquerydatatransferEmpty
Deletes the specified transfer run. (runs.delete)
get()  : Google_Service_BigQueryDataTransfer_TransferRun
Returns information about the particular transfer run. (runs.get)
listProjectsLocationsTransferConfigsRuns()  : Google_Service_BigQueryDataTransfer_ListTransferRunsResponse
Returns information about running and completed jobs.
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 —

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

delete()

Deletes the specified transfer run. (runs.delete)

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

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or project s/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_ id}

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

Optional parameters.

Return values
Google_Service_BigQueryDataTransfer_BigquerydatatransferEmpty —

get()

Returns information about the particular transfer run. (runs.get)

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

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or project s/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_ id}

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

Optional parameters.

Return values
Google_Service_BigQueryDataTransfer_TransferRun —

listProjectsLocationsTransferConfigsRuns()

Returns information about running and completed jobs.

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

(runs.listProjectsLocationsTransferConfigsRuns)

Parameters
$parent : string

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

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

Optional parameters.

Tags
opt_param

int pageSize Page size. The default page size is the maximum value of 1000 results.

opt_param

string states When specified, only transfer runs with requested states are returned.

opt_param

string pageToken Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

opt_param

string runAttempt Indicates how run attempts are to be pulled.

Return values
Google_Service_BigQueryDataTransfer_ListTransferRunsResponse —

convertToArrayAndStripNulls()

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

Search results