- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ScheduleService::Client.
Client for the ScheduleService service.
A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the ScheduleService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all ScheduleService clients ::Google::Cloud::AIPlatform::V1::ScheduleService::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the ScheduleService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_schedule
def create_schedule(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
def create_schedule(parent: nil, schedule: nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
Creates a Schedule.
def create_schedule(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
create_schedule
via a request object, either of type
CreateScheduleRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::CreateScheduleRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_schedule(parent: nil, schedule: nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
create_schedule
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the Location to create the Schedule in.
Format:
projects/{project}/locations/{location}
- schedule (::Google::Cloud::AIPlatform::V1::Schedule, ::Hash) — Required. The Schedule to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::Schedule)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ScheduleService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::CreateScheduleRequest.new # Call the create_schedule method. result = client.create_schedule request # The returned object is of type Google::Cloud::AIPlatform::V1::Schedule. p result
#delete_schedule
def delete_schedule(request, options = nil) -> ::Gapic::Operation
def delete_schedule(name: nil) -> ::Gapic::Operation
Deletes a Schedule.
def delete_schedule(request, options = nil) -> ::Gapic::Operation
delete_schedule
via a request object, either of type
DeleteScheduleRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::DeleteScheduleRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_schedule(name: nil) -> ::Gapic::Operation
delete_schedule
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the Schedule resource to be deleted.
Format:
projects/{project}/locations/{location}/schedules/{schedule}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ScheduleService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::DeleteScheduleRequest.new # Call the delete_schedule method. result = client.delete_schedule request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#get_schedule
def get_schedule(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
def get_schedule(name: nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
Gets a Schedule.
def get_schedule(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
get_schedule
via a request object, either of type
GetScheduleRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::GetScheduleRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_schedule(name: nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
get_schedule
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the Schedule resource.
Format:
projects/{project}/locations/{location}/schedules/{schedule}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::Schedule)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ScheduleService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::GetScheduleRequest.new # Call the get_schedule method. result = client.get_schedule request # The returned object is of type Google::Cloud::AIPlatform::V1::Schedule. p result
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client
Get the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Client)
#initialize
def initialize() { |config| ... } -> Client
Create a new ScheduleService client object.
- (config) — Configure the ScheduleService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::AIPlatform::V1::ScheduleService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::AIPlatform::V1::ScheduleService::Client.new do |config| config.timeout = 10.0 end
#list_schedules
def list_schedules(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Schedule>
def list_schedules(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Schedule>
Lists Schedules in a Location.
def list_schedules(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Schedule>
list_schedules
via a request object, either of type
ListSchedulesRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ListSchedulesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_schedules(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Schedule>
list_schedules
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the Location to list the Schedules from.
Format:
projects/{project}/locations/{location}
-
filter (::String) —
Lists the Schedules that match the filter expression. The following fields are supported:
display_name
: Supports=
,!=
comparisons, and:
wildcard.state
: Supports=
and!=
comparisons.request
: Supports existence of thecreate_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format.start_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format.end_time
: Supports=
,!=
,<
,>
,<=
,>=
comparisons and:*
existence check. Values must be in RFC 3339 format.next_run_time
: Supports=
,!=
,<
,>
,<=
, and>=
comparisons. Values must be in RFC 3339 format.
Filter expressions can be combined together using logical operators (
NOT
,AND
&OR
). The syntax to define filter expression is based on https://google.aip.dev/160.Examples:
state="ACTIVE" AND display_name:"my_schedule_*"
NOT display_name="my_schedule"
create_time>"2021-05-18T00:00:00Z"
end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*
create_pipeline_job_request:*
- page_size (::Integer) — The standard list page size. Default to 100 if not specified.
- page_token (::String) — The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.
-
order_by (::String) —
A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided.
For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order.
If order_by is not specified, it will order by default with create_time in descending order.
Supported fields:
create_time
start_time
end_time
next_run_time
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Schedule>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Schedule>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ScheduleService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ListSchedulesRequest.new # Call the list_schedules method. result = client.list_schedules request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::AIPlatform::V1::Schedule. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Client)
#operations_client
def operations_client() -> ::Google::Cloud::AIPlatform::V1::ScheduleService::Operations
Get the associated client for long-running operations.
#pause_schedule
def pause_schedule(request, options = nil) -> ::Google::Protobuf::Empty
def pause_schedule(name: nil) -> ::Google::Protobuf::Empty
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.
def pause_schedule(request, options = nil) -> ::Google::Protobuf::Empty
pause_schedule
via a request object, either of type
PauseScheduleRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::PauseScheduleRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def pause_schedule(name: nil) -> ::Google::Protobuf::Empty
pause_schedule
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the Schedule resource to be paused.
Format:
projects/{project}/locations/{location}/schedules/{schedule}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ScheduleService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::PauseScheduleRequest.new # Call the pause_schedule method. result = client.pause_schedule request # The returned object is of type Google::Protobuf::Empty. p result
#resume_schedule
def resume_schedule(request, options = nil) -> ::Google::Protobuf::Empty
def resume_schedule(name: nil, catch_up: nil) -> ::Google::Protobuf::Empty
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.
def resume_schedule(request, options = nil) -> ::Google::Protobuf::Empty
resume_schedule
via a request object, either of type
ResumeScheduleRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ResumeScheduleRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def resume_schedule(name: nil, catch_up: nil) -> ::Google::Protobuf::Empty
resume_schedule
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the Schedule resource to be resumed.
Format:
projects/{project}/locations/{location}/schedules/{schedule}
- catch_up (::Boolean) — 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ScheduleService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ResumeScheduleRequest.new # Call the resume_schedule method. result = client.resume_schedule request # The returned object is of type Google::Protobuf::Empty. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_schedule
def update_schedule(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
def update_schedule(schedule: nil, update_mask: nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
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.
def update_schedule(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
update_schedule
via a request object, either of type
UpdateScheduleRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::UpdateScheduleRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_schedule(schedule: nil, update_mask: nil) -> ::Google::Cloud::AIPlatform::V1::Schedule
update_schedule
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
schedule (::Google::Cloud::AIPlatform::V1::Schedule, ::Hash) —
Required. The Schedule which replaces the resource on the server. The following restrictions will be applied:
- The scheduled request type cannot be changed.
- The non-empty fields cannot be unset.
- The output_only fields will be ignored if specified.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update mask applies to the resource. See google.protobuf.FieldMask.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::Schedule)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::ScheduleService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::UpdateScheduleRequest.new # Call the update_schedule method. result = client.update_schedule request # The returned object is of type Google::Cloud::AIPlatform::V1::Schedule. p result