Class: Ansible::Ruby::Modules::Proxysql_scheduler

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Proxysql_scheduler

Defined in:

lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb

Overview

The M(proxysql_scheduler) module adds or removes schedules using the proxysql admin interface.

Instance Method Summary

• #active ⇒ Boolean^?

  A schedule with I(active) set to C(False) will be tracked in the database, but will be never loaded in the in-memory data structures.

• #arg1 ⇒ Object^?

  Argument that can be passed to the job.

• #arg2 ⇒ Object^?

  Argument that can be passed to the job.

• #arg3 ⇒ Object^?

  Argument that can be passed to the job.

• #arg4 ⇒ Object^?

  Argument that can be passed to the job.

• #arg5 ⇒ Object^?

  Argument that can be passed to the job.

• #comment ⇒ Object^?

  Text field that can be used for any purposed defined by the user.

• #filename ⇒ String

  Full path of the executable to be executed.

• #force_delete ⇒ Boolean^?

  By default we avoid deleting more than one schedule in a single batch, however if you need this behaviour and you’re not concerned about the schedules deleted, you can set I(force_delete) to C(True).

• #interval_ms ⇒ Integer^?

  How often (in millisecond) the job will be started.

• #state ⇒ :present, ...

  When C(present) - adds the schedule, when C(absent) - removes the schedule.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#active ⇒ Boolean^?

Returns A schedule with I(active) set to C(False) will be tracked in the database, but will be never loaded in the in-memory data structures.

Returns:

• (Boolean, nil) —

  A schedule with I(active) set to C(False) will be tracked in the database, but will be never loaded in the in-memory data structures.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 12

attribute :active

#arg1 ⇒ Object^?

Returns Argument that can be passed to the job.

Returns:

• (Object, nil) —

  Argument that can be passed to the job.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 24

attribute :arg1

#arg2 ⇒ Object^?

Returns Argument that can be passed to the job.

Returns:

• (Object, nil) —

  Argument that can be passed to the job.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 27

attribute :arg2

#arg3 ⇒ Object^?

Returns Argument that can be passed to the job.

Returns:

• (Object, nil) —

  Argument that can be passed to the job.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 30

attribute :arg3

#arg4 ⇒ Object^?

Returns Argument that can be passed to the job.

Returns:

• (Object, nil) —

  Argument that can be passed to the job.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 33

attribute :arg4

#arg5 ⇒ Object^?

Returns Argument that can be passed to the job.

Returns:

• (Object, nil) —

  Argument that can be passed to the job.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 36

attribute :arg5

#comment ⇒ Object^?

Returns Text field that can be used for any purposed defined by the user.

Returns:

• (Object, nil) —

  Text field that can be used for any purposed defined by the user.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 39

attribute :comment

#filename ⇒ String

Returns Full path of the executable to be executed.

Returns:

• (String) —

  Full path of the executable to be executed.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 20

attribute :filename

#force_delete ⇒ Boolean^?

Returns By default we avoid deleting more than one schedule in a single batch, however if you need this behaviour and you’re not concerned about the schedules deleted, you can set I(force_delete) to C(True).

Returns:

• (Boolean, nil) —

  By default we avoid deleting more than one schedule in a single batch, however if you need this behaviour and you’re not concerned about the schedules deleted, you can set I(force_delete) to C(True).

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 46

attribute :force_delete

#interval_ms ⇒ Integer^?

Returns How often (in millisecond) the job will be started. The minimum value for I(interval_ms) is 100 milliseconds.

Returns:

• (Integer, nil) —

  How often (in millisecond) the job will be started. The minimum value for I(interval_ms) is 100 milliseconds.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 16

attribute :interval_ms

#state ⇒ :present, ...

Returns When C(present) - adds the schedule, when C(absent) - removes the schedule.

Returns:

• (:present, :absent, nil) —

  When C(present) - adds the schedule, when C(absent) - removes the schedule.

# File 'lib/ansible/ruby/modules/generated/database/proxysql/proxysql_scheduler.rb', line 42

attribute :state