Class: Ansible::Ruby::Modules::Gitlab_project

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

Overview

When the project does not exists in Gitlab, it will be created. When the project does exists and state=absent, the project will be deleted. When changes are made to the project, the project will be updated.

Instance Method Summary collapse

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

#description ⇒ Object?

Returns An description for the project.

Returns:

  • (Object, nil) —

    An description for the project.



44
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 44

attribute :description

#group ⇒ String?

Returns The name of the group of which this projects belongs to.,When not provided, project will belong to user which is configured in ‘login_user’ or ‘login_token’,When provided with username, project will be created for this user. ‘login_user’ or ‘login_token’ needs admin rights.

Returns:

  • (String, nil) —

    The name of the group of which this projects belongs to.,When not provided, project will belong to user which is configured in ‘login_user’ or ‘login_token’,When provided with username, project will be created for this user. ‘login_user’ or ‘login_token’ needs admin rights.



33
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 33

attribute :group

#import_url ⇒ Boolean?

Returns Git repository which will me imported into gitlab.,Gitlab server needs read access to this git repository.

Returns:

  • (Boolean, nil) —

    Git repository which will me imported into gitlab.,Gitlab server needs read access to this git repository.



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

attribute :import_url

#issues_enabled ⇒ Boolean?

Returns Whether you want to create issues or not.,Possible values are true and false.

Returns:

  • (Boolean, nil) —

    Whether you want to create issues or not.,Possible values are true and false.



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

attribute :issues_enabled

#login_password ⇒ String?

Returns Gitlab password for login_user.

Returns:

  • (String, nil) —

    Gitlab password for login_user



25
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 25

attribute :login_password

#login_token ⇒ String?

Returns Gitlab token for logging in.

Returns:

  • (String, nil) —

    Gitlab token for logging in.



29
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 29

attribute :login_token

#login_user ⇒ String?

Returns Gitlab user name.

Returns:

  • (String, nil) —

    Gitlab user name.



21
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 21

attribute :login_user

#merge_requests_enabled ⇒ Boolean?

Returns If merge requests can be made or not.,Possible values are true and false.

Returns:

  • (Boolean, nil) —

    If merge requests can be made or not.,Possible values are true and false.



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

attribute :merge_requests_enabled

#name ⇒ String

Returns The name of the project.

Returns:

  • (String) —

    The name of the project



37
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 37

attribute :name

#path ⇒ Object?

Returns The path of the project you want to create, this will be server_url/<group>/path,If not supplied, name will be used.

Returns:

  • (Object, nil) —

    The path of the project you want to create, this will be server_url/<group>/path,If not supplied, name will be used.



41
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 41

attribute :path

#public ⇒ Boolean?

Returns If the project is public available or not.,Setting this to true is same as setting visibility_level to 20.,Possible values are true and false.

Returns:

  • (Boolean, nil) —

    If the project is public available or not.,Setting this to true is same as setting visibility_level to 20.,Possible values are true and false.



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

attribute :public

#server_url ⇒ String

Returns Url of Gitlab server, with protocol (http or https).

Returns:

  • (String) —

    Url of Gitlab server, with protocol (http or https).



13
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 13

attribute :server_url

#snippets_enabled ⇒ Boolean?

Returns If creating snippets should be available or not.,Possible values are true and false.

Returns:

  • (Boolean, nil) —

    If creating snippets should be available or not.,Possible values are true and false.



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

attribute :snippets_enabled

#state ⇒ :present, ...

Returns create or delete project.,Possible values are present and absent.

Returns:

  • (:present, :absent, nil) —

    create or delete project.,Possible values are present and absent.



75
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 75

attribute :state

#validate_certs ⇒ Boolean?

Returns When using https if SSL certificate needs to be verified.

Returns:

  • (Boolean, nil) —

    When using https if SSL certificate needs to be verified.



17
 
# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_project.rb', line 17

attribute :validate_certs

#visibility_level ⇒ Integer?

Returns Private. visibility_level is 0. Project access must be granted explicitly for each user.,Internal. visibility_level is 10. The project can be cloned by any logged in user.,Public. visibility_level is 20. The project can be cloned without any authentication.,Possible values are 0, 10 and 20.

Returns:

  • (Integer, nil) —

    Private. visibility_level is 0. Project access must be granted explicitly for each user.,Internal. visibility_level is 10. The project can be cloned by any logged in user.,Public. visibility_level is 20. The project can be cloned without any authentication.,Possible values are 0, 10 and 20.



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

attribute :visibility_level

#wiki_enabled ⇒ Boolean?

Returns If an wiki for this project should be available or not.,Possible values are true and false.

Returns:

  • (Boolean, nil) —

    If an wiki for this project should be available or not.,Possible values are true and false.



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

attribute :wiki_enabled