Documentation

Google_Service_BigQueryDataTransfer_Resource_ProjectsDataSources extends Google_Service_Resource
in package

The "dataSources" collection of methods.

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

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.
checkValidCreds()  : Google_Service_BigQueryDataTransfer_CheckValidCredsResponse
Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config. (dataSources.checkValidCreds)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_BigQueryDataTransfer_DataSource
Retrieves a supported data source and returns its settings, which can be used for UI rendering. (dataSources.get)
listProjectsDataSources()  : Google_Service_BigQueryDataTransfer_ListDataSourcesResponse
Lists supported data sources and returns their settings, which can be used for UI rendering. (dataSources.listProjectsDataSources)
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 —

checkValidCreds()

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config. (dataSources.checkValidCreds)

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

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

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

Optional parameters.

Return values
Google_Service_BigQueryDataTransfer_CheckValidCredsResponse —

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

get()

Retrieves a supported data source and returns its settings, which can be used for UI rendering. (dataSources.get)

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

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

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

Optional parameters.

Return values
Google_Service_BigQueryDataTransfer_DataSource —

listProjectsDataSources()

Lists supported data sources and returns their settings, which can be used for UI rendering. (dataSources.listProjectsDataSources)

public listProjectsDataSources(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigQueryDataTransfer_ListDataSourcesResponse
Parameters
$parent : string

Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/{project_id}/locations/{location_id}

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

Optional parameters.

Tags
opt_param

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

opt_param

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

Return values
Google_Service_BigQueryDataTransfer_ListDataSourcesResponse —

convertToArrayAndStripNulls()

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

Search results