Class: Ansible::Ruby::Modules::Jira

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb

Overview

Create and modify issues in a JIRA instance.

Instance Method Summary

• #assignee ⇒ String^?

  Sets the assignee on create or transition operations.

• #comment ⇒ String^?

  The comment text to add.

• #description ⇒ String^?

  The issue description, where appropriate.

• #fields ⇒ Hash^?

  This is a free-form data structure that can contain arbitrary data.

• #issue ⇒ String^?

  An existing issue key to operate on.

• #issuetype ⇒ String^?

  The issue type, for issue creation.

• #operation ⇒ :create, ...

  The operation to perform.

• #password ⇒ String

  The password to log-in with.

• #project ⇒ String^?

  The project for this operation.

• #status ⇒ String^?

  The desired status; only relevant for the transition operation.

• #summary ⇒ String^?

  The issue summary, where appropriate.

• #uri ⇒ String

  Base URI for the JIRA instance.

• #username ⇒ String

  The username to log-in with.

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

#assignee ⇒ String^?

Returns Sets the assignee on create or transition operations. Note not all transitions will allow this.

Returns:

• (String, nil) —

  Sets the assignee on create or transition operations. Note not all transitions will allow this.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 55

attribute :assignee

#comment ⇒ String^?

Returns The comment text to add.

Returns:

• (String, nil) —

  The comment text to add.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 47

attribute :comment

#description ⇒ String^?

Returns The issue description, where appropriate.

Returns:

• (String, nil) —

  The issue description, where appropriate.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 35

attribute :description

#fields ⇒ Hash^?

Returns This is a free-form data structure that can contain arbitrary data. This is passed directly to the JIRA REST API (possibly after merging with other required data, as when passed to create). See examples for more information, and the JIRA REST API for the structure required for various fields.

Returns:

• (Hash, nil) —

  This is a free-form data structure that can contain arbitrary data. This is passed directly to the JIRA REST API (possibly after merging with other required data, as when passed to create). See examples for more information, and the JIRA REST API for the structure required for various fields.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 59

attribute :fields

#issue ⇒ String^?

Returns An existing issue key to operate on.

Returns:

• (String, nil) —

  An existing issue key to operate on.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 43

attribute :issue

#issuetype ⇒ String^?

Returns The issue type, for issue creation.

Returns:

• (String, nil) —

  The issue type, for issue creation.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 39

attribute :issuetype

#operation ⇒ :create, ...

Returns The operation to perform.

Returns:

• (:create, :comment, :edit, :fetch, :transition) —

  The operation to perform.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 15

attribute :operation

#password ⇒ String

Returns The password to log-in with.

Returns:

• (String) —

  The password to log-in with.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 23

attribute :password

#project ⇒ String^?

Returns The project for this operation. Required for issue creation.

Returns:

• (String, nil) —

  The project for this operation. Required for issue creation.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 27

attribute :project

#status ⇒ String^?

Returns The desired status; only relevant for the transition operation.

Returns:

• (String, nil) —

  The desired status; only relevant for the transition operation.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 51

attribute :status

#summary ⇒ String^?

Returns The issue summary, where appropriate.

Returns:

• (String, nil) —

  The issue summary, where appropriate.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 31

attribute :summary

#uri ⇒ String

Returns Base URI for the JIRA instance.

Returns:

• (String) —

  Base URI for the JIRA instance

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 11

attribute :uri

#username ⇒ String

Returns The username to log-in with.

Returns:

• (String) —

  The username to log-in with.

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/jira.rb', line 19

attribute :username