A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
ScheduleServiceClient(ScheduleServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ScheduleServiceClient const &
|
ScheduleServiceClient(ScheduleServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ScheduleServiceClient &&
|
ScheduleServiceClient(std::shared_ptr< ScheduleServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ScheduleServiceConnection >
|
opts |
Options
|
Operators
operator=(ScheduleServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ScheduleServiceClient const &
|
Returns | |
---|---|
Type | Description |
ScheduleServiceClient & |
operator=(ScheduleServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ScheduleServiceClient &&
|
Returns | |
---|---|
Type | Description |
ScheduleServiceClient & |
Functions
CreateSchedule(std::string const &, google::cloud::aiplatform::v1::Schedule const &, Options)
Creates a Schedule.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the Schedule in. Format: |
schedule |
google::cloud::aiplatform::v1::Schedule const &
Required. The Schedule to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Schedule > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSchedule(google::cloud::aiplatform::v1::CreateScheduleRequest const &, Options)
Creates a Schedule.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateScheduleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Schedule > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteSchedule(std::string const &, Options)
Deletes a Schedule.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Schedule resource to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteSchedule(google::cloud::aiplatform::v1::DeleteScheduleRequest const &, Options)
Deletes a Schedule.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteScheduleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
GetSchedule(std::string const &, Options)
Gets a Schedule.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Schedule resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Schedule > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSchedule(google::cloud::aiplatform::v1::GetScheduleRequest const &, Options)
Gets a Schedule.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetScheduleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Schedule > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListSchedules(std::string const &, Options)
Lists Schedules in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list the Schedules from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Schedule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSchedules(google::cloud::aiplatform::v1::ListSchedulesRequest, Options)
Lists Schedules in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListSchedulesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Schedule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PauseSchedule(std::string const &, Options)
Pauses a Schedule.
Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Schedule resource to be paused. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
PauseSchedule(google::cloud::aiplatform::v1::PauseScheduleRequest const &, Options)
Pauses a Schedule.
Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::PauseScheduleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ResumeSchedule(std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Schedule resource to be resumed. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ResumeSchedule(std::string const &, bool, Options)
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.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Schedule resource to be resumed. Format: |
catch_up |
bool
Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ResumeSchedule(google::cloud::aiplatform::v1::ResumeScheduleRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ResumeScheduleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
UpdateSchedule(google::cloud::aiplatform::v1::Schedule const &, google::protobuf::FieldMask const &, Options)
Updates an active or paused Schedule.
When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.
Parameters | |
---|---|
Name | Description |
schedule |
google::cloud::aiplatform::v1::Schedule const &
Required. The Schedule which replaces the resource on the server. The following restrictions will be applied:
|
update_mask |
google::protobuf::FieldMask const &
Required. The update mask applies to the resource. See google.protobuf.FieldMask. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Schedule > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateSchedule(google::cloud::aiplatform::v1::UpdateScheduleRequest const &, Options)
Updates an active or paused Schedule.
When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateScheduleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Schedule > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |