Documentation

Google_Service_Dataflow_Resource_ProjectsTemplates extends Google_Service_Resource
in package

The "templates" collection of methods.

Typical usage is: $dataflowService = new Google_Service_Dataflow(...); $templates = $dataflowService->templates;

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_Dataflow_Job
Creates a Cloud Dataflow job from a template. (templates.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Dataflow_GetTemplateResponse
Get the template associated with a template. (templates.get)
launch()  : Google_Service_Dataflow_LaunchTemplateResponse
Launch a template. (templates.launch)
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 Cloud Dataflow job from a template. (templates.create)

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

Required. The ID of the Cloud Platform project that the job belongs to.

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

Optional parameters.

Return values
Google_Service_Dataflow_Job —

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()

Get the template associated with a template. (templates.get)

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

Required. The ID of the Cloud Platform project that the job belongs to.

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

Optional parameters.

Tags
opt_param

string gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

opt_param

string view The view to retrieve. Defaults to METADATA_ONLY.

opt_param

string location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.

Return values
Google_Service_Dataflow_GetTemplateResponse —

launch()

Launch a template. (templates.launch)

public launch(string $projectId, Google_Service_Dataflow_LaunchTemplateParameters $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_LaunchTemplateResponse
Parameters
$projectId : string

Required. The ID of the Cloud Platform project that the job belongs to.

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

Optional parameters.

Tags
opt_param

string location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.

opt_param

bool validateOnly If true, the request is validated but not actually executed. Defaults to false.

opt_param

string dynamicTemplate.stagingLocation Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with gs://.

opt_param

string gcsPath A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

opt_param

string dynamicTemplate.gcsPath Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object.

Return values
Google_Service_Dataflow_LaunchTemplateResponse —

convertToArrayAndStripNulls()

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

Search results