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

Inherits:
Base show all
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 collapse

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

#account ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :account

#application ⇒ String

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

Returns:

  • (String) —

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



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

attribute :application

#cache ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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



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

attribute :cache

#changes ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :changes

#description ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :description

#email ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :email

#event_handlers ⇒ Object?

Returns 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). C(name) used as event handler name which can be used later to make changes to it.,C(src) is full path to file with event handler code.,C(channels) is name of channel from which event handler is waiting for events.,C(event) is type of event which is able to trigger event handler: I(js-before-publish), I(js-after-publish), I(js-after-presence).,Each entry for existing handlers should contain C(name) (so target handler can be identified). Rest parameters (C(src), C(channels) and C(event)) can be added if changes required for them.,It is possible to rename event handler by adding C(changes) key to event handler payload and pass dictionary, which will contain single key C(name), where new name should be passed.,To remove particular event handler it is possible to set C(state) for it to C(absent) and it will be removed.

Returns:

  • (Object, nil) —

    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). C(name) used as event handler name which can be used later to make changes to it.,C(src) is full path to file with event handler code.,C(channels) is name of channel from which event handler is waiting for events.,C(event) is type of event which is able to trigger event handler: I(js-before-publish), I(js-after-publish), I(js-after-presence).,Each entry for existing handlers should contain C(name) (so target handler can be identified). Rest parameters (C(src), C(channels) and C(event)) can be added if changes required for them.,It is possible to rename event handler by adding C(changes) key to event handler payload and pass dictionary, which will contain single key C(name), where new name should be passed.,To remove particular event handler it is possible to set C(state) for it to C(absent) and it will be removed.



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

attribute :event_handlers

#keyset ⇒ String

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

Returns:

  • (String) —

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



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

attribute :keyset

#name ⇒ String

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

Returns:

  • (String) —

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



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

attribute :name

#password ⇒ String?

Returns 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).

Returns:

  • (String, nil) —

    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).



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

attribute :password

#state ⇒ :started, ...

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

Returns:

  • (:started, :stopped, :present, :absent, nil) —

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



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

attribute :state

#validate_certs ⇒ Boolean?

Returns This key allow to try skip certificates check when performing REST API calls. Sometimes host may have issues with certificates on it and this will cause problems to call PubNub REST API.,If check should be ignored C(False) should be passed to this parameter.

Returns:

  • (Boolean, nil) —

    This key allow to try skip certificates check when performing REST API calls. Sometimes host may have issues with certificates on it and this will cause problems to call PubNub REST API.,If check should be ignored C(False) should be passed to this parameter.



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

attribute :validate_certs