Class: Ansible::Ruby::Modules::Pubnub_blocks

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb

Overview

This module allows Ansible to interface with the PubNub BLOCKS infrastructure by providing the following operations: create / remove, start / stop and rename for blocks and create / modify / remove for event handlers

Instance Method Summary

• #account ⇒ Object^?

  Name of PubNub account for from which C(application) will be used to manage blocks.,user account.

• #application ⇒ String

  Name of target PubNub application for which blocks configuration on specific C(keyset) will be done.

• #cache ⇒ Object^?

  In case if single play use blocks management module few times it is preferred to enabled ‘caching’ by making previous module to share gathered artifacts and pass them to this parameter.rn.

• #changes ⇒ Object^?

  List of fields which should be changed by block itself (doesn’t affect any event handlers).,Possible options for change is: C(name).

• #description ⇒ String^?

  Short block description which will be later visible on admin.pubnub.com description for existing block.

• #email ⇒ String^?

  Email from account for which new session should be started.,Not required if C(cache) contains result of previous module call (in same play).

• #event_handlers ⇒ Object^?

  List of event handlers which should be updated for specified block C(name).,Each entry for new event handler should contain: C(name), C(src), C(channels), C(event).

• #keyset ⇒ String

  Name of application’s keys set which is bound to managed blocks.

• #name ⇒ String

  Name of managed block which will be later visible on admin.pubnub.com.

• #password ⇒ String^?

  Password which match to account to which specified C(email) belong.,Not required if C(cache) contains result of previous module call (in same play).

• #state ⇒ :started, ...

  Intended block state after event handlers creation / update process will be completed.

• #validate_certs ⇒ Boolean^?

  This key allow to try skip certificates check when performing REST API calls.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#account ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 23

attribute :account

#application ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 26

attribute :application

#cache ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 20

attribute :cache

#changes ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 49

attribute :changes

#description ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 42

attribute :description

#email ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 12

attribute :email

#event_handlers ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 46

attribute :event_handlers

#keyset ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 30

attribute :keyset

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 38

attribute :name

#password ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 16

attribute :password

#state ⇒ :started, ...

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 34

attribute :state

#validate_certs ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/pubnub/pubnub_blocks.rb', line 52

attribute :validate_certs