Documentation

Google_Service_Dataflow_Resource_ProjectsCatalogTemplates extends Google_Service_Resource
in package

Application

The "catalogTemplates" collection of methods.

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

$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.
commit() : Google_Service_Dataflow_TemplateVersion: Creates a new TemplateVersion (Important: not new Template) entry in the spanner table. Requires project_id and display_name (template).
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Dataflow_DataflowEmpty: Deletes an existing Template. Do nothing if Template does not exist.
get() : Google_Service_Dataflow_TemplateVersion: Get TemplateVersion using project_id and display_name with an optional version_id field. Get latest (has tag "latest") TemplateVersion if version_id not set. (catalogTemplates.get)
label() : Google_Service_Dataflow_ModifyTemplateVersionLabelResponse: Updates the label of the TemplateVersion. Label can be duplicated in Template, so either add or remove the label in the TemplateVersion.
tag() : Google_Service_Dataflow_ModifyTemplateVersionTagResponse: Updates the tag of the TemplateVersion, and tag is unique in Template. If tag exists in another TemplateVersion in the Template, updates the tag to this TemplateVersion will remove it from the old TemplateVersion and add it to this TemplateVersion. If request is remove_only (remove_only = true), remove the tag from this TemplateVersion. (catalogTemplates.tag)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

commit()

Creates a new TemplateVersion (Important: not new Template) entry in the spanner table. Requires project_id and display_name (template).


    public
                commit(string $name, Google_Service_Dataflow_CommitTemplateVersionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_TemplateVersion

(catalogTemplates.commit)

Parameters

$name : string: The location of the template, name includes project_id and display_name. Commit using project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1}
$postBody : Google_Service_Dataflow_CommitTemplateVersionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_TemplateVersion —

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>

Return values

string —

$requestUrl

delete()

Deletes an existing Template. Do nothing if Template does not exist.


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

(catalogTemplates.delete)

Parameters

$name : string: name includes project_id and display_name. Delete by project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_DataflowEmpty —

get()

Get TemplateVersion using project_id and display_name with an optional version_id field. Get latest (has tag "latest") TemplateVersion if version_id not set. (catalogTemplates.get)


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

Parameters

$name : string: Resource name includes project_id and display_name. version_id is optional. Get the latest TemplateVersion if version_id not set. Get by project_id(pid1) and display_name(tid1): Format: projects/{pid1}/catalogTemplates/{tid1} Get by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_TemplateVersion —

label()

Updates the label of the TemplateVersion. Label can be duplicated in Template, so either add or remove the label in the TemplateVersion.


    public
                label(string $name, Google_Service_Dataflow_ModifyTemplateVersionLabelRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_ModifyTemplateVersionLabelResponse

(catalogTemplates.label)

Parameters

$name : string: Resource name includes project_id, display_name, and version_id. Updates by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid}
$postBody : Google_Service_Dataflow_ModifyTemplateVersionLabelRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_ModifyTemplateVersionLabelResponse —

tag()

Updates the tag of the TemplateVersion, and tag is unique in Template. If tag exists in another TemplateVersion in the Template, updates the tag to this TemplateVersion will remove it from the old TemplateVersion and add it to this TemplateVersion. If request is remove_only (remove_only = true), remove the tag from this TemplateVersion. (catalogTemplates.tag)


    public
                tag(string $name, Google_Service_Dataflow_ModifyTemplateVersionTagRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_ModifyTemplateVersionTagResponse

Parameters

$name : string: Resource name includes project_id, display_name, and version_id. Updates by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/{pid1}/catalogTemplates/{tid1@vid}
$postBody : Google_Service_Dataflow_ModifyTemplateVersionTagRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_ModifyTemplateVersionTagResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —