Class: Ansible::Ruby::Modules::Gitlab_hooks

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb

Overview

Adds, updates and removes project hooks

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

#access_token ⇒ String?

Returns The oauth key provided by GitLab. One of access_token or private_token is required. See docs.gitlab.com/ee/api/oauth2.html.

Returns:



16
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 16

attribute :access_token

#api_url ⇒ String

Returns GitLab API url, e.g. gitlab.example.com/api.

Returns:



12
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 12

attribute :api_url

#enable_ssl_verification ⇒ :yes, ...

Returns Whether GitLab will do SSL verification when triggering the hook.

Returns:

  • (:yes, :no, nil) —

    Whether GitLab will do SSL verification when triggering the hook



67
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 67

attribute :enable_ssl_verification

#hook_url ⇒ String

Returns The url that you want GitLab to post to, this is used as the primary key for updates and deletion.

Returns:

  • (String) —

    The url that you want GitLab to post to, this is used as the primary key for updates and deletion.



27
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 27

attribute :hook_url

#issues_events ⇒ :yes, ...

Returns Trigger hook on issues events.

Returns:

  • (:yes, :no, nil) —

    Trigger hook on issues events



39
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 39

attribute :issues_events

#job_events ⇒ :yes, ...

Returns Trigger hook on job events.

Returns:

  • (:yes, :no, nil) —

    Trigger hook on job events



55
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 55

attribute :job_events

#merge_requests_events ⇒ :yes, ...

Returns Trigger hook on merge requests events.

Returns:

  • (:yes, :no, nil) —

    Trigger hook on merge requests events



43
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 43

attribute :merge_requests_events

#note_events ⇒ :yes, ...

Returns Trigger hook on note events.

Returns:

  • (:yes, :no, nil) —

    Trigger hook on note events



51
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 51

attribute :note_events

#pipeline_events ⇒ :yes, ...

Returns Trigger hook on pipeline events.

Returns:

  • (:yes, :no, nil) —

    Trigger hook on pipeline events



59
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 59

attribute :pipeline_events

#private_token ⇒ Object?

Returns Personal access token to use. One of private_token or access_token is required. See docs.gitlab.com/ee/user/profile/personal_access_tokens.html.

Returns:



20
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 20

attribute :private_token

#project ⇒ String, Integer

Returns Numeric project id or name of project in the form of group/name.

Returns:

  • (String, Integer) —

    Numeric project id or name of project in the form of group/name



23
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 23

attribute :project

#push_events ⇒ :yes, ...

Returns Trigger hook on push events.

Returns:

  • (:yes, :no, nil) —

    Trigger hook on push events



35
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 35

attribute :push_events

#state ⇒ :present, :absent

Returns When C(present) the hook will be updated to match the input or created if it doesn’t exist. When C(absent) it will be deleted if it exists.

Returns:

  • (:present, :absent) —

    When C(present) the hook will be updated to match the input or created if it doesn’t exist. When C(absent) it will be deleted if it exists.



31
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 31

attribute :state

#tag_push_events ⇒ :yes, ...

Returns Trigger hook on tag push events.

Returns:

  • (:yes, :no, nil) —

    Trigger hook on tag push events



47
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 47

attribute :tag_push_events

#token ⇒ String?

Returns Secret token to validate hook messages at the receiver.,If this is present it will always result in a change as it cannot be retrieved from GitLab.,Will show up in the X-Gitlab-Token HTTP request header.

Returns:

  • (String, nil) —

    Secret token to validate hook messages at the receiver.,If this is present it will always result in a change as it cannot be retrieved from GitLab.,Will show up in the X-Gitlab-Token HTTP request header



71
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 71

attribute :token

#wiki_page_events ⇒ :yes, ...

Returns Trigger hook on wiki events.

Returns:

  • (:yes, :no, nil) —

    Trigger hook on wiki events



63
 
# File 'lib/ansible/ruby/modules/generated/source_control/gitlab_hooks.rb', line 63

attribute :wiki_page_events