Method: googleapis.aiplatform.v1beta1.projects.locations.schedules.resume

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.

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first.

Arguments

Parameters
name	string Required. The name of the Schedule resource to be resumed. Format: projects/{project}/locations/{location}/schedules/{schedule}
region	string Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
body	object (GoogleCloudAiplatformV1beta1ResumeScheduleRequest) 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 will be empty.

Subworkflow snippet

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

YAML

- resume:
    call: googleapis.aiplatform.v1beta1.projects.locations.schedules.resume
    args:
        name: ...
        region: ...
        body:
            catchUp: ...
    result: resumeResult

JSON

[
  {
    "resume": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.schedules.resume",
      "args": {
        "name": "...",
        "region": "...",
        "body": {
          "catchUp": "..."
        }
      },
      "result": "resumeResult"
    }
  }
]