- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
HTTP request
POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:schedule
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
The integration resource name. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "triggerId": string, "parameters": { object ( |
Fields | |
---|---|
triggerId |
Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(triggerId) |
parameters |
Passed in as parameters to each integration execution. |
scheduleTime |
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: |
requestId |
This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. |
parameterEntries[] |
Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. |
inputParameters |
Optional. Input parameters used by integration execution. |
userGeneratedExecutionId |
Optional. This is a unique id provided by the method caller. If provided this will be used as the executionId when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens. |
Response body
If successful, the response body contains an instance of ScheduleIntegrationsResponse
.
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.integrations.invoke
For more information, see the IAM documentation.