Class: Ansible::Ruby::Modules::Gem

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb

Overview

Manage installation and uninstallation of Ruby gems.

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

#build_flags ⇒ Object?

Returns Allow adding build flags for gem compilation.

Returns:

  • (Object, nil) —

    Allow adding build flags for gem compilation



49
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 49

attribute :build_flags

#executable ⇒ Object?

Returns Override the path to the gem executable.

Returns:

  • (Object, nil) —

    Override the path to the gem executable



34
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 34

attribute :executable

#gem_source ⇒ String?

Returns The path to a local gem used as installation source.

Returns:

  • (String, nil) —

    The path to a local gem used as installation source.



19
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 19

attribute :gem_source

#include_dependencies ⇒ :yes, ...

Returns Whether to include dependencies or not.

Returns:

  • (:yes, :no, nil) —

    Whether to include dependencies or not.



23
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 23

attribute :include_dependencies

#include_doc ⇒ String?

Returns Install with or without docs.

Returns:

  • (String, nil) —

    Install with or without docs.



45
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 45

attribute :include_doc

#name ⇒ String

Returns The name of the gem to be managed.

Returns:

  • (String) —

    The name of the gem to be managed.



11
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 11

attribute :name

#pre_release ⇒ String?

Returns Allow installation of pre-release versions of the gem.

Returns:

  • (String, nil) —

    Allow installation of pre-release versions of the gem.



41
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 41

attribute :pre_release

#repository ⇒ Object?

Returns The repository from which the gem will be installed.

Returns:

  • (Object, nil) —

    The repository from which the gem will be installed



27
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 27

attribute :repository

#state ⇒ :present, ...

Returns The desired state of the gem. C(latest) ensures that the latest version is installed.

Returns:

  • (:present, :absent, :latest, nil) —

    The desired state of the gem. C(latest) ensures that the latest version is installed.



15
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 15

attribute :state

#user_install ⇒ String?

Returns Install gem in user’s local gems cache or for all users.

Returns:

  • (String, nil) —

    Install gem in user’s local gems cache or for all users



30
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 30

attribute :user_install

#version ⇒ String?

Returns Version of the gem to be installed/removed.

Returns:

  • (String, nil) —

    Version of the gem to be installed/removed.



37
 
# File 'lib/ansible/ruby/modules/generated/core/packaging/language/gem.rb', line 37

attribute :version