Class: Kafka::FFI::Admin::ConfigEntry

Inherits:
OpaquePointer show all
Defined in:
lib/kafka/ffi/admin/config_entry.rb

Instance Attribute Summary

Attributes inherited from OpaquePointer

#pointer

Instance Method Summary collapse

Methods inherited from OpaquePointer

by_ref, from_native, inherited, #initialize, to_native

Constructor Details

This class inherits a constructor from Kafka::FFI::OpaquePointer

Instance Method Details

#is_default ⇒ nil, Boolean Also known as: default?

Returns true if the config property is set to its default. Only returns a boolean when use on a ConfigEntry from a DescribeConfigs result.

Returns:

  • (nil) —

    ConfigEntry was not returned by DescribeConfigs

  • (Boolean) —

    If the property is set to default



68
69
70
71
 
# File 'lib/kafka/ffi/admin/config_entry.rb', line 68

def is_default
  val = ::Kafka::FFI.rd_kafka_ConfigEntry_is_default(self)
  val == -1 ? nil : val == 1
end

#is_read_only ⇒ nil, Boolean Also known as: read_only?

Returns true if the config property is read-only on the broker. Only returns a boolean when called on a ConfigEntry from a DescribeConfigs result.

Returns:

  • (nil) —

    ConfigEntry was not returned by DescribeConfigs

  • (Boolean) —

    If the property is read only



58
59
60
61
 
# File 'lib/kafka/ffi/admin/config_entry.rb', line 58

def is_read_only
  val = ::Kafka::FFI.rd_kafka_ConfigEntry_is_read_only(self)
  val == -1 ? nil : val == 1
end

#is_sensitive ⇒ nil, Boolean Also known as: sensitive?

Returns true if the config property is sensitive. Only returns a boolean when use on a ConfigEntry from a DescribeConfigs result.

Returns:

  • (nil) —

    ConfigEntry was not returned by DescribeConfigs

  • (Boolean) —

    If the property is set to default



78
79
80
81
 
# File 'lib/kafka/ffi/admin/config_entry.rb', line 78

def is_sensitive
  val = ::Kafka::FFI.rd_kafka_ConfigEntry_is_sensitive(self)
  val == -1 ? nil : val == 1
end

#is_synonym ⇒ Boolean Also known as: synonym?

Returns true if the entry is a synonym for another config option.

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/kafka/ffi/admin/config_entry.rb', line 86

def is_synonym
  ::Kafka::FFI.rd_kafka_ConfigEntry_is_sensitive(self) == 1
end

#name ⇒ String

Returns the configuration property name

Returns:

  • (String) —

    Configuration property name



10
11
12
 
# File 'lib/kafka/ffi/admin/config_entry.rb', line 10

def name
  ::Kafka::FFI.rd_kafka_ConfigEntry_name(self)
end

#source ⇒ Symbol

Returns the source of the config

Returns:

  • (Symbol) —

    Source of the config

See Also:

  • config_source


27
28
29
 
# File 'lib/kafka/ffi/admin/config_entry.rb', line 27

def source
  ::Kafka::FFI.rd_kafka_ConfigEntry_source(self)
end

#synonyms ⇒ nil, Array<ConfigEntry>

List of synonyms for the config entry

Returns:

  • (nil) —

    ConfigEntry was not returned by DescribeConfigs

  • (Array<ConfigEntry>) —

    Set of synonyms for the config



35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/kafka/ffi/admin/config_entry.rb', line 35

def synonyms
  count = ::FFI::MemoryPointer.new(:pointer)

  entries = ::Kafka::FFI.rd_kafka_ConfigEntry_synonyms(self, count)
  if entries.null?
    return nil
  end

  entries.read_array_of_pointer(count.read(:size_t)).map do |ptr|
    ConfigEntry.new(ptr)
  end
ensure
  count.free
end

#value ⇒ nil, String

Returns the configuration value

Returns:

  • (nil) —

    Value is sensitive or unset

  • (String) —

    Configuration value



18
19
20
 
# File 'lib/kafka/ffi/admin/config_entry.rb', line 18

def value
  ::Kafka::FFI.rd_kafka_ConfigEntry_value(self)
end