Class: Ansible::Ruby::Modules::Flatpak

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/packaging/os/flatpak.rb

Overview

Allows users to add or remove flatpaks. See the M(flatpak_remote) module for managing flatpak remotes.

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

#executable ⇒ String?

Returns The path to the C(flatpak) executable to use.,By default, this module looks for the C(flatpak) executable on the path.

Returns:

  • (String, nil) —

    The path to the C(flatpak) executable to use.,By default, this module looks for the C(flatpak) executable on the path.



13
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/flatpak.rb', line 13

attribute :executable

#method ⇒ :system, ...

Returns The installation method to use.,Defines if the I(flatpak) is supposed to be installed globally for the whole C(system) or only for the current C(user).

Returns:

  • (:system, :user, nil) —

    The installation method to use.,Defines if the I(flatpak) is supposed to be installed globally for the whole C(system) or only for the current C(user).



17
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/flatpak.rb', line 17

attribute :method

#name ⇒ String

Returns The name of the flatpak to manage.,When used with I(state=present), I(name) can be specified as an C(http(s)) URL to a C(flatpakref) file or the unique reverse DNS name that identifies a flatpak.,When suppying a reverse DNS name, you can use the I(remote) option to specify on what remote to look for the flatpak. An example for a reverse DNS name is C(org.gnome.gedit).,When used with I(state=absent), it is recommended to specify the name in the reverse DNS format.,When supplying an C(http(s)) URL with I(state=absent), the module will try to match the installed flatpak based on the name of the flatpakref to remove it. However, there is no guarantee that the names of the flatpakref file and the reverse DNS name of the installed flatpak do match.

Returns:

  • (String) —

    The name of the flatpak to manage.,When used with I(state=present), I(name) can be specified as an C(http(s)) URL to a C(flatpakref) file or the unique reverse DNS name that identifies a flatpak.,When suppying a reverse DNS name, you can use the I(remote) option to specify on what remote to look for the flatpak. An example for a reverse DNS name is C(org.gnome.gedit).,When used with I(state=absent), it is recommended to specify the name in the reverse DNS format.,When supplying an C(http(s)) URL with I(state=absent), the module will try to match the installed flatpak based on the name of the flatpakref to remove it. However, there is no guarantee that the names of the flatpakref file and the reverse DNS name of the installed flatpak do match.



21
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/flatpak.rb', line 21

attribute :name

#remote ⇒ String?

Returns The flatpak remote (repository) to install the flatpak from.,By default, C(flathub) is assumed, but you do need to add the flathub flatpak_remote before you can use this.,See the M(flatpak_remote) module for managing flatpak remotes.

Returns:

  • (String, nil) —

    The flatpak remote (repository) to install the flatpak from.,By default, C(flathub) is assumed, but you do need to add the flathub flatpak_remote before you can use this.,See the M(flatpak_remote) module for managing flatpak remotes.



25
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/flatpak.rb', line 25

attribute :remote

#state ⇒ :absent, ...

Returns Indicates the desired package state.

Returns:

  • (:absent, :present, nil) —

    Indicates the desired package state.



29
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/flatpak.rb', line 29

attribute :state