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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_retention_policy.rb

Overview

Manage InfluxDB retention policies

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

#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



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

attribute :database_name

#default ⇒ Object

Returns Sets the retention policy as default retention policy.

Returns:

  • (Object) —

    Sets the retention policy as default retention policy



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

attribute :default

#duration ⇒ String

Returns Determines how long InfluxDB should keep the data.

Returns:

  • (String) —

    Determines how long InfluxDB should keep the data



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

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



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

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



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

attribute :password

#policy_name ⇒ String

Returns Name of the retention policy.

Returns:

  • (String) —

    Name of the retention policy



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

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



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

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



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

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



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

attribute :username