Method: projects.locations.integrations.schedule

Schedules an integration for execution.

HTTP request

POST https://integrations.googleapis.com/v2/{parent=projects/*/locations/*/integrations/*}:schedule

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The integration resource name.

Query parameters

Parameters
triggerId

string

Required. The API trigger id associated with the integration. An integration can have multiple triggerId. This field is required to disambiguate which trigger should be invoked
scheduleTime

string (Timestamp format)

Optional. The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
requestId

string

Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.

Request body

The request body contains an instance of Struct.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

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 parent resource:

  • integrations.integrations.invoke

For more information, see the IAM documentation.