Class: Google::Cloud::AIPlatform::V1::Schedule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/schedule.rb

Overview

An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.

Defined Under Namespace

Modules: State Classes: RunResponse

Instance Attribute Summary collapse

Instance Attribute Details

#allow_queueing ⇒ ::Boolean

Returns Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.

Returns:

  • (::Boolean) —

    Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#catch_up ⇒ ::Boolean (readonly)

Returns Output only. 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. Default to false.

Returns:

  • (::Boolean) —

    Output only. 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. Default to false.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#create_notebook_execution_job_request ⇒ ::Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest

Returns Request for NotebookService.CreateNotebookExecutionJob.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#create_pipeline_job_request ⇒ ::Google::Cloud::AIPlatform::V1::CreatePipelineJobRequest

Returns Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Schedule was created.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#cron ⇒ ::String

Returns Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".

Returns:

  • (::String) —

    Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#display_name ⇒ ::String

Returns Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#last_pause_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Schedule was last paused. Unset if never paused.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#last_resume_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#last_scheduled_run_response ⇒ ::Google::Cloud::AIPlatform::V1::Schedule::RunResponse (readonly)

Returns Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Schedule::RunResponse) —

    Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#max_concurrent_run_count ⇒ ::Integer

Returns Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).

Returns:

  • (::Integer) —

    Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#max_run_count ⇒ ::Integer

Returns Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

Returns:

  • (::Integer) —

    Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#name ⇒ ::String

Returns Immutable. The resource name of the Schedule.

Returns:

  • (::String) —

    Immutable. The resource name of the Schedule.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#next_run_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#started_run_count ⇒ ::Integer (readonly)

Returns Output only. The number of runs started by this schedule.

Returns:

  • (::Integer) —

    Output only. The number of runs started by this schedule.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#state ⇒ ::Google::Cloud::AIPlatform::V1::Schedule::State (readonly)

Returns Output only. The state of this Schedule.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Schedule was updated.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/schedule.rb', line 118

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of a scheduled run.
  # @!attribute [rw] scheduled_run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The scheduled run time based on the user-specified schedule.
  # @!attribute [rw] run_response
  #   @return [::String]
  #     The response of the scheduled run.
  class RunResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible state of the schedule.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # The Schedule is active. Runs are being scheduled on the user-specified
    # timespec.
    ACTIVE = 1

    # The schedule is paused. No new runs will be created until the schedule
    # is resumed. Already started runs will be allowed to complete.
    PAUSED = 2

    # The Schedule is completed. No new runs will be scheduled. Already started
    # runs will be allowed to complete. Schedules in completed state cannot be
    # paused or resumed.
    COMPLETED = 3
  end
end