Class: Google::Cloud::Notebooks::V1::Schedule

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

Overview

The definition of a schedule.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Time the schedule was created.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

#cron_schedule ⇒ ::String

Returns Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html.

Returns:

  • (::String) —

    Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

#description ⇒ ::String

Returns A brief description of this environment.

Returns:

  • (::String) —

    A brief description of this environment.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

#display_name ⇒ ::String (readonly)

Returns Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens -, and underscores _.

Returns:

  • (::String) —

    Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens -, and underscores _.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

#execution_template ⇒ ::Google::Cloud::Notebooks::V1::ExecutionTemplate

Returns Notebook Execution Template corresponding to this schedule.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The name of this schedule. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}.

Returns:

  • (::String) —

    Output only. The name of this schedule. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

#recent_executions ⇒ ::Array<::Google::Cloud::Notebooks::V1::Execution> (readonly)

Returns Output only. The most recent execution names triggered from this schedule and their corresponding states.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

#state ⇒ ::Google::Cloud::Notebooks::V1::Schedule::State

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

#time_zone ⇒ ::String

Returns Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).

Returns:

  • (::String) —

    Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

    Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end

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

Returns Output only. Time the schedule was last updated.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/notebooks/v1/schedule.rb', line 68

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

  # State of the job.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The job is executing normally.
    ENABLED = 1

    # The job is paused by the user. It will not execute. A user can
    # intentionally pause the job using
    # [PauseJobRequest][].
    PAUSED = 2

    # The job is disabled by the system due to error. The user
    # cannot directly set a job to be disabled.
    DISABLED = 3

    # The job state resulting from a failed [CloudScheduler.UpdateJob][]
    # operation. To recover a job from this state, retry
    # [CloudScheduler.UpdateJob][] until a successful response is received.
    UPDATE_FAILED = 4

    # The schedule resource is being created.
    INITIALIZING = 5

    # The schedule resource is being deleted.
    DELETING = 6
  end
end