Class: Ansible::Ruby::Modules::Gitlab_deploy_key

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/source_control/gitlab_deploy_key.rb

Overview

Adds, updates and removes project deploy keys

Instance Method Summary

• #access_token ⇒ String^?

  The oauth key provided by GitLab.

• #api_url ⇒ String

  GitLab API url, e.g.

• #can_push ⇒ :yes, ...

  Whether this key can push to the project.

• #key ⇒ String

  Deploy key.

• #private_token ⇒ Object^?

  Personal access token to use.

• #project ⇒ String

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

• #state ⇒ :present, :absent

  When C(present) the deploy key added to the project if it doesn’t exist.,When C(absent) it will be removed from the project if it exists.

• #title ⇒ String

  Deploy key’s title.

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:

• (String, nil) —

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

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

attribute :access_token

#api_url ⇒ String

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

Returns:

• (String) —

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

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

attribute :api_url

#can_push ⇒ :yes, ...

Returns Whether this key can push to the project.

Returns:

• (:yes, :no, nil) —

  Whether this key can push to the project

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

attribute :can_push

#key ⇒ String

Returns Deploy key.

Returns:

• (String) —

  Deploy key

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

attribute :key

#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:

• (Object, nil) —

  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

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

attribute :private_token

#project ⇒ String

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

Returns:

• (String) —

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

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

attribute :project

#state ⇒ :present, :absent

Returns When C(present) the deploy key added to the project if it doesn’t exist.,When C(absent) it will be removed from the project if it exists.

Returns:

• (:present, :absent) —

  When C(present) the deploy key added to the project if it doesn’t exist.,When C(absent) it will be removed from the project if it exists

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

attribute :state

#title ⇒ String

Returns Deploy key’s title.

Returns:

• (String) —

  Deploy key’s title

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

attribute :title