Class: Cadenya::Resources::Agents::Schedules

Inherits:
Object
  • Object
show all
Defined in:
lib/cadenya/resources/agents/schedules.rb,
sig/cadenya/resources/agents/schedules.rbs

Overview

Manage recurring schedules attached to agents. Schedules trigger objectives on a cadence defined by AgentScheduleSpec.Schedule.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Schedules

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Schedules.

Parameters:



297
298
299
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 297

def initialize(client:)
  @client = client
end

Instance Method Details

#archive(agent_id, id, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::Agents::AgentSchedule

Some parameter documentations has been truncated, see Models::Agents::ScheduleArchiveParams for more details.

Transitions a schedule to STATE_ARCHIVED and removes its underlying timer. Archiving is terminal: archived schedules never fire and cannot be reactivated; create a new schedule instead.

Parameters:

  • agent_id (String) —

    Agent ID. Accepts the canonical agent_… form or the external_id:<value> form

  • id (String) —

    Schedule ID. Accepts the canonical as_… form or the external_id:<value> form

  • workspace_id (String) —

    Workspace ID.

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 214

def archive(agent_id, id, params = {})
  parsed, options = Cadenya::Agents::ScheduleArchiveParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/agents/%2$s/schedules/%3$s:archive", workspace_id, agent_id, id],
    model: Cadenya::Agents::AgentSchedule,
    options: options
  )
end

#create(agent_id, metadata:, spec:, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::Agents::AgentSchedule

Some parameter documentations has been truncated, see Models::Agents::ScheduleCreateParams for more details.

Creates a new schedule for an agent

Parameters:

Returns:

See Also:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 29

def create(agent_id, params)
  parsed, options = Cadenya::Agents::ScheduleCreateParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/agents/%2$s/schedules", workspace_id, agent_id],
    body: parsed,
    model: Cadenya::Agents::AgentSchedule,
    options: options
  )
end

#delete(agent_id, id, workspace_id: nil, request_options: {}) ⇒ nil

Some parameter documentations has been truncated, see Models::Agents::ScheduleDeleteParams for more details.

Deletes a schedule from an agent

Parameters:

  • agent_id (String) —

    Agent ID. Accepts the canonical agent_… form or the external_id:<value> form

  • id (String) —

    Schedule ID. Accepts the canonical as_… form or the external_id:<value> form

  • workspace_id (String) —

    Workspace ID.

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 180

def delete(agent_id, id, params = {})
  parsed, options = Cadenya::Agents::ScheduleDeleteParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :delete,
    path: ["v1/workspaces/%1$s/agents/%2$s/schedules/%3$s", workspace_id, agent_id, id],
    model: NilClass,
    options: options
  )
end

#list(agent_id, workspace_id: nil, cursor: nil, include_info: nil, labels: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, request_options: {}) ⇒ Cadenya::Internal::CursorPagination<Cadenya::Models::Agents::AgentSchedule>

Some parameter documentations has been truncated, see Models::Agents::ScheduleListParams for more details.

Lists all schedules for an agent

Parameters:

  • agent_id (String) —

    Path param: Agent ID. Accepts the canonical agent_… form or the `external_id:<

  • workspace_id (String) —

    Path param: Workspace ID.

  • cursor (String) —

    Query param: Pagination cursor from previous response.

  • include_info (Boolean) —

    Query param: When true, the info field on each returned schedule is populated.

  • labels (String) —

    Query param: Filters by metadata labels. Comma-separated key=value pairs,

  • limit (Integer) —

    Query param: Maximum number of results to return.

  • prefix (String) —

    Query param: Filter expression (query param: prefix).

  • query (String) —

    Query param: Free-form search query.

  • sort_order (String) —

    Query param: Sort order for results (asc or desc by creation time).

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 145

def list(agent_id, params = {})
  parsed, options = Cadenya::Agents::ScheduleListParams.dump_request(params)
  query = Cadenya::Internal::Util.encode_query_params(parsed)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/agents/%2$s/schedules", workspace_id, agent_id],
    query: query.transform_keys(include_info: "includeInfo", sort_order: "sortOrder"),
    page: Cadenya::Internal::CursorPagination,
    model: Cadenya::Agents::AgentSchedule,
    options: options
  )
end

#pause(agent_id, id, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::Agents::AgentSchedule

Some parameter documentations has been truncated, see Models::Agents::SchedulePauseParams for more details.

Transitions a schedule to STATE_PAUSED. Paused schedules retain history but do not fire.

Parameters:

  • agent_id (String) —

    Agent ID. Accepts the canonical agent_… form or the external_id:<value> form

  • id (String) —

    Schedule ID. Accepts the canonical as_… form or the external_id:<value> form

  • workspace_id (String) —

    Workspace ID.

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 247

def pause(agent_id, id, params = {})
  parsed, options = Cadenya::Agents::SchedulePauseParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/agents/%2$s/schedules/%3$s:pause", workspace_id, agent_id, id],
    model: Cadenya::Agents::AgentSchedule,
    options: options
  )
end

#resume(agent_id, id, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::Agents::AgentSchedule

Some parameter documentations has been truncated, see Models::Agents::ScheduleResumeParams for more details.

Transitions a paused schedule back to STATE_ACTIVE so it fires on its cadence again. Archived schedules cannot be resumed.

Parameters:

  • agent_id (String) —

    Agent ID. Accepts the canonical agent_… form or the external_id:<value> form

  • id (String) —

    Schedule ID. Accepts the canonical as_… form or the external_id:<value> form

  • workspace_id (String) —

    Workspace ID.

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 280

def resume(agent_id, id, params = {})
  parsed, options = Cadenya::Agents::ScheduleResumeParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/agents/%2$s/schedules/%3$s:resume", workspace_id, agent_id, id],
    model: Cadenya::Agents::AgentSchedule,
    options: options
  )
end

#retrieve(agent_id, id, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::Agents::AgentSchedule

Some parameter documentations has been truncated, see Models::Agents::ScheduleRetrieveParams for more details.

Retrieves a schedule by ID from an agent

Parameters:

  • agent_id (String) —

    Agent ID. Accepts the canonical agent_… form or the external_id:<value> form

  • id (String) —

    Schedule ID. Accepts the canonical as_… form or the external_id:<value> form

  • workspace_id (String) —

    Workspace ID.

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 62

def retrieve(agent_id, id, params = {})
  parsed, options = Cadenya::Agents::ScheduleRetrieveParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/agents/%2$s/schedules/%3$s", workspace_id, agent_id, id],
    model: Cadenya::Agents::AgentSchedule,
    options: options
  )
end

#update(agent_id, id, workspace_id: nil, metadata: nil, spec: nil, update_mask: nil, request_options: {}) ⇒ Cadenya::Models::Agents::AgentSchedule

Some parameter documentations has been truncated, see Models::Agents::ScheduleUpdateParams for more details.

Updates a schedule for an agent

Parameters:

  • agent_id (String) —

    Path param: Agent ID. Accepts the canonical agent_… form or the `external_id:<

  • id (String) —

    Path param: Schedule ID. Accepts the canonical as_… form or the `external_id:<

  • workspace_id (String) —

    Path param: Workspace ID.

  • metadata (Cadenya::Models::UpdateResourceMetadata) —

    Body param: UpdateResourceMetadata contains the user-provided fields for updatin

  • spec (Cadenya::Models::Agents::AgentScheduleSpec) —

    Body param: AgentScheduleSpec is the user-provided configuration for a schedule.

  • update_mask (String) —

    Body param: Fields to update.

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/cadenya/resources/agents/schedules.rb', line 100

def update(agent_id, id, params = {})
  parsed, options = Cadenya::Agents::ScheduleUpdateParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :patch,
    path: ["v1/workspaces/%1$s/agents/%2$s/schedules/%3$s", workspace_id, agent_id, id],
    body: parsed,
    model: Cadenya::Agents::AgentSchedule,
    options: options
  )
end