Method: projects.locations.templates.use

Use the template to create integration. This api would keep track of usageCount and lastUsedTime. PERMISSION_DENIED would be thrown if template is not accessible by client.

HTTP request

POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/templates/*}:use

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name that is associated with the Template.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "subIntegrations": {
    string: {
      object (IntegrationDetails)
    },
    ...
  },
  "integrationRegion": string
}
Fields
integrationDetails

object (IntegrationDetails)

Required. Integration details which would be created via templates.
subIntegrations

map (key: string, value: object (IntegrationDetails))

Optional. Sub Integration which would be created via templates.
integrationRegion

string

Required. The region of the Integration to be created.

Response body

Response for use template

If successful, the response body contains data with the following structure:

JSON representation 
{
  "integrationVersion": {
    object (IntegrationVersion)
  },
  "subIntegrationVersions": [
    {
      object (IntegrationVersion)
    }
  ]
}
Fields
integrationVersion

object (IntegrationVersion)

IntegrationVersion which is created.
subIntegrationVersions[]

object (IntegrationVersion)

Sub integration versions which are created.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • integrations.templates.use

For more information, see the IAM documentation.