Documentation

Google_Service_BigQueryDataTransfer_Resource_ProjectsLocationsTransferConfigs extends Google_Service_Resource
in package

The "transferConfigs" collection of methods.

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

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.
create()  : Google_Service_BigQueryDataTransfer_TransferConfig
Creates a new data transfer configuration. (transferConfigs.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_BigQueryDataTransfer_BigquerydatatransferEmpty
Deletes a data transfer configuration, including any associated transfer runs and logs. (transferConfigs.delete)
get()  : Google_Service_BigQueryDataTransfer_TransferConfig
Returns information about a data transfer config. (transferConfigs.get)
listProjectsLocationsTransferConfigs()  : Google_Service_BigQueryDataTransfer_ListTransferConfigsResponse
Returns information about all data transfers in the project.
patch()  : Google_Service_BigQueryDataTransfer_TransferConfig
Updates a data transfer configuration. All fields must be set, even if they are not updated. (transferConfigs.patch)
scheduleRuns()  : Google_Service_BigQueryDataTransfer_ScheduleTransferRunsResponse
Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
startManualRuns()  : Google_Service_BigQueryDataTransfer_StartManualTransferRunsResponse
Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. (transferConfigs.startManualRuns)
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 —

create()

Creates a new data transfer configuration. (transferConfigs.create)

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

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

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

Optional parameters.

Tags
opt_param

string versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

opt_param

string serviceAccountName Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

opt_param

string authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id==_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

Return values
Google_Service_BigQueryDataTransfer_TransferConfig —

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 a data transfer configuration, including any associated transfer runs and logs. (transferConfigs.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} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

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

Optional parameters.

Return values
Google_Service_BigQueryDataTransfer_BigquerydatatransferEmpty —

get()

Returns information about a data transfer config. (transferConfigs.get)

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

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

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

Optional parameters.

Return values
Google_Service_BigQueryDataTransfer_TransferConfig —

listProjectsLocationsTransferConfigs()

Returns information about all data transfers in the project.

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

(transferConfigs.listProjectsLocationsTransferConfigs)

Parameters
$parent : string

Required. The BigQuery project id for which data sources should be returned: 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 ListTransfersRequest list results. For multiple-page results, ListTransfersResponse 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.

opt_param

string dataSourceIds When specified, only configurations of requested data sources are returned.

Return values
Google_Service_BigQueryDataTransfer_ListTransferConfigsResponse —

patch()

Updates a data transfer configuration. All fields must be set, even if they are not updated. (transferConfigs.patch)

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

The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.

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

Optional parameters.

Tags
opt_param

string versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

opt_param

string updateMask Required. Required list of fields to be updated in this request.

opt_param

string authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id==_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

opt_param

string serviceAccountName Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

Return values
Google_Service_BigQueryDataTransfer_TransferConfig —

scheduleRuns()

Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

public scheduleRuns(string $parent, Google_Service_BigQueryDataTransfer_ScheduleTransferRunsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigQueryDataTransfer_ScheduleTransferRunsResponse

(transferConfigs.scheduleRuns)

Parameters
$parent : string

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

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

Optional parameters.

Return values
Google_Service_BigQueryDataTransfer_ScheduleTransferRunsResponse —

startManualRuns()

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. (transferConfigs.startManualRuns)

public startManualRuns(string $parent, Google_Service_BigQueryDataTransfer_StartManualTransferRunsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigQueryDataTransfer_StartManualTransferRunsResponse
Parameters
$parent : string

Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

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

Optional parameters.

Return values
Google_Service_BigQueryDataTransfer_StartManualTransferRunsResponse —

convertToArrayAndStripNulls()

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

Search results