Method: googleapis.integrations.v1.projects.locations.integrations.schedule

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

Arguments

Parameters
name	string Required. The integration resource name.
location	string Location of the HTTP endpoint. For example, if location is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. If not set, the global endpint will be used. See service endpoints.
body	object (GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest) Required.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- schedule:
    call: googleapis.integrations.v1.projects.locations.integrations.schedule
    args:
        name: ...
        body:
            inputParameters: ...
            parameterEntries: ...
            parameters:
                parameters: ...
            requestId: ...
            scheduleTime: ...
            triggerId: ...
    result: scheduleResult

JSON

[
  {
    "schedule": {
      "call": "googleapis.integrations.v1.projects.locations.integrations.schedule",
      "args": {
        "name": "...",
        "body": {
          "inputParameters": "...",
          "parameterEntries": "...",
          "parameters": {
            "parameters": "..."
          },
          "requestId": "...",
          "scheduleTime": "...",
          "triggerId": "..."
        }
      },
      "result": "scheduleResult"
    }
  }
]