ScheduleService class final
A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.
Constructors
- ScheduleService({required Client client})
-
Creates a
ScheduleServiceusingclientfor transport. - ScheduleService.fromApiKey([String? apiKey])
-
Creates a
ScheduleServicethat does authentication through an API key.factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancelOperation(
CancelOperationRequest request) → Future< void> -
Provides the
Operationsservice functionality in this service. -
close(
) → void - Closes the client and cleans up any resources associated with it.
-
createSchedule(
CreateScheduleRequest request) → Future< Schedule> - Creates a Schedule.
-
deleteOperation(
DeleteOperationRequest request) → Future< void> -
Provides the
Operationsservice functionality in this service. -
deleteSchedule(
DeleteScheduleRequest request) → Future< Operation< Empty, DeleteOperationMetadata> > - Deletes a Schedule.
-
getIamPolicy(
GetIamPolicyRequest request) → Future< Policy> - Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
-
getLocation(
GetLocationRequest request) → Future< Location> - Gets information about a location.
-
getOperation<
T extends ProtoMessage, S extends ProtoMessage> (Operation< T, S> request) → Future<Operation< T, S> > -
Provides the
Operationsservice functionality in this service. -
getSchedule(
GetScheduleRequest request) → Future< Schedule> - Gets a Schedule.
-
listLocations(
ListLocationsRequest request) → Future< ListLocationsResponse> - Lists information about the supported locations for this service.
-
listOperations(
ListOperationsRequest request) → Future< ListOperationsResponse> -
Provides the
Operationsservice functionality in this service. -
listSchedules(
ListSchedulesRequest request) → Future< ListSchedulesResponse> - Lists Schedules in a Location.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pauseSchedule(
PauseScheduleRequest request) → Future< void> -
Pauses a Schedule. Will mark
Schedule.stateto 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. -
resumeSchedule(
ResumeScheduleRequest request) → Future< void> -
Resumes a paused Schedule to start scheduling new runs. Will mark
Schedule.stateto 'ACTIVE'. Only paused Schedule can be resumed. -
setIamPolicy(
SetIamPolicyRequest request) → Future< Policy> - Sets the access control policy on the specified resource. Replaces any existing policy.
-
testIamPermissions(
TestIamPermissionsRequest request) → Future< TestIamPermissionsResponse> -
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a
NOT_FOUNDerror. -
toString(
) → String -
A string representation of this object.
inherited
-
updateSchedule(
UpdateScheduleRequest request) → Future< Schedule> - Updates an active or paused Schedule.
-
waitOperation(
WaitOperationRequest request) → Future< Operation< ProtoMessage, ProtoMessage> > -
Provides the
Operationsservice functionality in this service.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited