Class: Ansible::Ruby::Modules::Maven_artifact

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

Overview

Downloads an artifact from a maven repository given the maven coordinates provided to the module. Can retrieve snapshots or release versions of the artifact and will resolve the latest available version if one is not available.

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

#artifact_id ⇒ String

Returns The maven artifactId coordinate.

Returns:

  • (String) —

    The maven artifactId coordinate



17
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 17

attribute :artifact_id

#classifier ⇒ Object?

Returns The maven classifier coordinate.

Returns:

  • (Object, nil) —

    The maven classifier coordinate



25
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 25

attribute :classifier

#dest ⇒ String

Returns The path where the artifact should be written to,If file mode or ownerships are specified and destination path already exists, they affect the downloaded file.

Returns:

  • (String) —

    The path where the artifact should be written to,If file mode or ownerships are specified and destination path already exists, they affect the downloaded file



44
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 44

attribute :dest

#extension ⇒ String?

Returns The maven type/extension coordinate.

Returns:

  • (String, nil) —

    The maven type/extension coordinate



28
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 28

attribute :extension

#group_id ⇒ String

Returns The Maven groupId coordinate.

Returns:

  • (String) —

    The Maven groupId coordinate



13
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 13

attribute :group_id

#keep_name ⇒ :yes, ...

Returns If C(yes), the downloaded artifact’s name is preserved, i.e the version number remains part of it.,This option only has effect when C(dest) is a directory and C(version) is set to C(latest).

Returns:

  • (:yes, :no, nil) —

    If C(yes), the downloaded artifact’s name is preserved, i.e the version number remains part of it.,This option only has effect when C(dest) is a directory and C(version) is set to C(latest).



60
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 60

attribute :keep_name

#password ⇒ String?

Returns The password to authenticate with to the Maven Repository. Use AWS secret access key of the repository is hosted on S3.

Returns:

  • (String, nil) —

    The password to authenticate with to the Maven Repository. Use AWS secret access key of the repository is hosted on S3



40
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 40

attribute :password

#repository_url ⇒ String?

Returns The URL of the Maven Repository to download from.,Use s3://… if the repository is hosted on Amazon S3, added in version 2.2.,Use file://… if the repository is local, added in version 2.6.

Returns:

  • (String, nil) —

    The URL of the Maven Repository to download from.,Use s3://… if the repository is hosted on Amazon S3, added in version 2.2.,Use file://… if the repository is local, added in version 2.6



32
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 32

attribute :repository_url

#state ⇒ :present, ...

Returns The desired state of the artifact.

Returns:

  • (:present, :absent, nil) —

    The desired state of the artifact



48
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 48

attribute :state

#timeout ⇒ Integer?

Returns Specifies a timeout in seconds for the connection attempt.

Returns:

  • (Integer, nil) —

    Specifies a timeout in seconds for the connection attempt



52
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 52

attribute :timeout

#username ⇒ String?

Returns The username to authenticate as to the Maven Repository. Use AWS secret key of the repository is hosted on S3.

Returns:

  • (String, nil) —

    The username to authenticate as to the Maven Repository. Use AWS secret key of the repository is hosted on S3



36
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 36

attribute :username

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be set to C(no) when no other option exists.

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only be set to C(no) when no other option exists.



56
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 56

attribute :validate_certs

#verify_checksum ⇒ :never, ...

Returns If C(never), the md5 checksum will never be downloaded and verified.,If C(download), the md5 checksum will be downloaded and verified only after artifact download. This is the default.,If C(change), the md5 checksum will be downloaded and verified if the destination already exist, to verify if they are identical. This was the behaviour before 2.6. Since it downloads the md5 before (maybe) downloading the artifact, and since some repository software, when acting as a proxy/cache, return a 404 error if the artifact has not been cached yet, it may fail unexpectedly. If you still need it, you should consider using C(always) instead - if you deal with a checksum, it is better to use it to verify integrity after download.,C(always) combines C(download) and C(change).

Returns:

  • (:never, :download, :change, :always, nil) —

    If C(never), the md5 checksum will never be downloaded and verified.,If C(download), the md5 checksum will be downloaded and verified only after artifact download. This is the default.,If C(change), the md5 checksum will be downloaded and verified if the destination already exist, to verify if they are identical. This was the behaviour before 2.6. Since it downloads the md5 before (maybe) downloading the artifact, and since some repository software, when acting as a proxy/cache, return a 404 error if the artifact has not been cached yet, it may fail unexpectedly. If you still need it, you should consider using C(always) instead - if you deal with a checksum, it is better to use it to verify integrity after download.,C(always) combines C(download) and C(change).



64
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 64

attribute :verify_checksum

#version ⇒ String?

Returns The maven version coordinate.

Returns:

  • (String, nil) —

    The maven version coordinate



21
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/maven_artifact.rb', line 21

attribute :version