class ProjectsLocationsTemplates extends Resource (View source)

The "templates" collection of methods.

Typical usage is:

 $integrationsService = new Google\Service\Integrations(...);
 $templates = $integrationsService->projects_locations_templates;

Methods

create(string $parent, GoogleCloudIntegrationsV1alphaTemplate $postBody, array $optParams = [])

Creates a new template (templates.create)

delete(string $name, array $optParams = [])

Deletes a template (templates.delete)

download(string $name, array $optParams = [])

Downloads a template. Retrieves the Template and returns the response as a string. (templates.download)

get(string $name, array $optParams = [])

Get a template in the specified project. (templates.get)

import(string $name, GoogleCloudIntegrationsV1alphaImportTemplateRequest $postBody, array $optParams = [])

Import the template to an existing integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client. (templates.import)

listProjectsLocationsTemplates(string $parent, array $optParams = [])

Lists all templates matching the filter.

patch(string $name, GoogleCloudIntegrationsV1alphaTemplate $postBody, array $optParams = [])

Updates the template by given id. (templates.patch)

search(string $parent, array $optParams = [])

Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.

share(string $name, GoogleCloudIntegrationsV1alphaShareTemplateRequest $postBody, array $optParams = [])

Share a template with other clients. Only the template owner can share the templates with other projects. PERMISSION_DENIED would be thrown if the request is not from the owner. (templates.share)

unshare(string $name, GoogleCloudIntegrationsV1alphaUnshareTemplateRequest $postBody, array $optParams = [])

Unshare a template from given clients. Owner of the template can unshare template with clients. Shared client can only unshare the template from itself. PERMISSION_DENIED would be thrown if request is not from owner or for unsharing itself. (templates.unshare)

upload(string $parent, GoogleCloudIntegrationsV1alphaUploadTemplateRequest $postBody, array $optParams = [])

Uploads a template. The content can be a previously downloaded template.

useProjectsLocationsTemplates(string $name, GoogleCloudIntegrationsV1alphaUseTemplateRequest $postBody, array $optParams = [])

Use the template to create integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client. (templates.useProjectsLocationsTemplates)

Details

GoogleCloudIntegrationsV1alphaTemplate create(string $parent, GoogleCloudIntegrationsV1alphaTemplate $postBody, array $optParams = [])

Creates a new template (templates.create)

Parameters

string $parent

Required. "projects/{project}/locations/{location}" format.

GoogleCloudIntegrationsV1alphaTemplate $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaTemplate

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a template (templates.delete)

Parameters

string $name

Required. The name that is associated with the Template.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudIntegrationsV1alphaDownloadTemplateResponse download(string $name, array $optParams = [])

Downloads a template. Retrieves the Template and returns the response as a string. (templates.download)

Parameters

string $name

Required. The template to download. Format: projects/{project}/locations/{location}/template/{template_id}

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaDownloadTemplateResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaTemplate get(string $name, array $optParams = [])

Get a template in the specified project. (templates.get)

Parameters

string $name

Required. The template to retrieve. Format: projects/{project}/locations/{location}/templates/{template}

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaTemplate

Exceptions

Exception

GoogleCloudIntegrationsV1alphaImportTemplateResponse import(string $name, GoogleCloudIntegrationsV1alphaImportTemplateRequest $postBody, array $optParams = [])

Import the template to an existing integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client. (templates.import)

Parameters

string $name

Required. The name that is associated with the Template.

GoogleCloudIntegrationsV1alphaImportTemplateRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaImportTemplateResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaListTemplatesResponse listProjectsLocationsTemplates(string $parent, array $optParams = [])

Lists all templates matching the filter.

(templates.listProjectsLocationsTemplates)

Parameters

string $parent

Required. The client, which owns this collection of Templates.

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaListTemplatesResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaTemplate patch(string $name, GoogleCloudIntegrationsV1alphaTemplate $postBody, array $optParams = [])

Updates the template by given id. (templates.patch)

Parameters

string $name

Identifier. Resource name of the template.

GoogleCloudIntegrationsV1alphaTemplate $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaTemplate

Exceptions

Exception

Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.

(templates.search)

Parameters

string $parent

Required. The client, which owns this collection of Templates.

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaSearchTemplatesResponse

Exceptions

Exception

GoogleProtobufEmpty share(string $name, GoogleCloudIntegrationsV1alphaShareTemplateRequest $postBody, array $optParams = [])

Share a template with other clients. Only the template owner can share the templates with other projects. PERMISSION_DENIED would be thrown if the request is not from the owner. (templates.share)

Parameters

string $name

Required. The name that is associated with the Template.

GoogleCloudIntegrationsV1alphaShareTemplateRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleProtobufEmpty unshare(string $name, GoogleCloudIntegrationsV1alphaUnshareTemplateRequest $postBody, array $optParams = [])

Unshare a template from given clients. Owner of the template can unshare template with clients. Shared client can only unshare the template from itself. PERMISSION_DENIED would be thrown if request is not from owner or for unsharing itself. (templates.unshare)

Parameters

string $name

Required. The name that is associated with the Template.

GoogleCloudIntegrationsV1alphaUnshareTemplateRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudIntegrationsV1alphaUploadTemplateResponse upload(string $parent, GoogleCloudIntegrationsV1alphaUploadTemplateRequest $postBody, array $optParams = [])

Uploads a template. The content can be a previously downloaded template.

Performs the same function as CreateTemplate, but accepts input in a string format, which holds the complete representation of the Template content. (templates.upload)

Parameters

string $parent

Required. The template to upload. Format: projects/{project}/locations/{location}

GoogleCloudIntegrationsV1alphaUploadTemplateRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaUploadTemplateResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaUseTemplateResponse useProjectsLocationsTemplates(string $name, GoogleCloudIntegrationsV1alphaUseTemplateRequest $postBody, array $optParams = [])

Use the template to create integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client. (templates.useProjectsLocationsTemplates)

Parameters

string $name

Required. The name that is associated with the Template.

GoogleCloudIntegrationsV1alphaUseTemplateRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaUseTemplateResponse

Exceptions

Exception