Class: Ansible::Ruby::Modules::Influxdb_retention_policy

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb

Instance Method Summary

• #database_name ⇒ String

  Name of the database where retention policy will be created.

• #default ⇒ Object

  Sets the retention policy as default retention policy.

• #duration ⇒ String

  Determines how long InfluxDB should keep the data.

• #hostname ⇒ String

  The hostname or IP address on which InfluxDB server is listening.

• #password ⇒ String^?

  Password that will be used to authenticate against InfluxDB server.

• #policy_name ⇒ String

  Name of the retention policy.

• #port ⇒ Integer^?

  The port on which InfluxDB server is listening.

• #replication ⇒ Integer

  Determines how many independent copies of each point are stored in the cluster.

• #username ⇒ String^?

  Username that will be used to authenticate against InfluxDB server.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#database_name ⇒ String

Returns Name of the database where retention policy will be created.

Returns:

• (String) —

  Name of the database where retention policy will be created

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 26

attribute :database_name

#default ⇒ Object

Returns Sets the retention policy as default retention policy.

Returns:

• (Object) —

  Sets the retention policy as default retention policy

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 42

attribute :default

#duration ⇒ String

Returns Determines how long InfluxDB should keep the data.

Returns:

• (String) —

  Determines how long InfluxDB should keep the data

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 34

attribute :duration

#hostname ⇒ String

Returns The hostname or IP address on which InfluxDB server is listening.

Returns:

• (String) —

  The hostname or IP address on which InfluxDB server is listening

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 10

attribute :hostname

#password ⇒ String^?

Returns Password that will be used to authenticate against InfluxDB server.

Returns:

• (String, nil) —

  Password that will be used to authenticate against InfluxDB server

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 18

attribute :password

#policy_name ⇒ String

Returns Name of the retention policy.

Returns:

• (String) —

  Name of the retention policy

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 30

attribute :policy_name

#port ⇒ Integer^?

Returns The port on which InfluxDB server is listening.

Returns:

• (Integer, nil) —

  The port on which InfluxDB server is listening

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 22

attribute :port

#replication ⇒ Integer

Returns Determines how many independent copies of each point are stored in the cluster.

Returns:

• (Integer) —

  Determines how many independent copies of each point are stored in the cluster

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 38

attribute :replication

#username ⇒ String^?

Returns Username that will be used to authenticate against InfluxDB server.

Returns:

• (String, nil) —

  Username that will be used to authenticate against InfluxDB server

# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb', line 14

attribute :username