Class: Confluent::Kafka::Acls

Inherits:
Object
  • Object
show all
Includes:
MintLogger, MintPress::Mixins::Properties
Defined in:
src/confluent-platform/lib/confluent-platform/model/acls.rb

Overview

Base class for Kafka Producer services of Confluent Kafka software. Provides methods for the configuring and managing Confluent Kafka Server.

Since:

  • 0.1.0

Properties (Read/Write)

  • #name ⇒ String
    Name of the Topic
    Property Attributes
    • required ⇒ true
    

45
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 45

property :Name, type: String, required: true
  • #partitions ⇒ Integer
    Number of partitions Note: Kafka topics are divided into a number of partitions. Partitions allow you to parallelize a topic by splitting the data in a particular topic across multiple brokers — each partition can be placed on a separate machine to allow for multiple consumers to read from a topic in parallel.
    Property Attributes
    • required ⇒ true
    

52
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 52

property :Partitions, type: Integer, required: true
  • #replication_factor ⇒ Integer
    Replication Factor for the Topic Note: Replication factor defines the number of copies of a topic in a Kafka cluster. Replication factor can be defined at topic level. Replicas are distributed evenly among Kafka brokers in a cluster.
    Property Attributes
    • required ⇒ true
    

57
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 57

property :ReplicationFactor, type: Integer, required: true
  • #leader ⇒ Integer
    ID of the leader
    Property Attributes 
    

59
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 59

property :Leader, type: Integer
  • #replicas ⇒ Array of ⇒ Integer

    Property Attributes 
    

60
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 60

property :Replicas, type: Integer, array: true
  • #isr ⇒ Array of ⇒ Integer
    ISR (in-sync replica) IDs. Note: Kafka replicates writes to the leader partition to followers (node/partition pair). A follower that is in-sync is called an ISR (in-sync replica)
    Property Attributes 
    

63
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 63

property :Isr, type: Integer, array: true
  • #replica_assignment ⇒ Hash (Default Value: {})
    A list of manual partition-to-broker assignments for the topic being created or altered broker_id_for_part1_replica1:broker_id_for_part1_replica2,broker_id_for_part2_replica1:broker_id_for_part2_replica2
    Property Attributes
    • default ⇒ {}
    

67
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 67

property :ReplicaAssignment, type: Hash, default: {}
  • #at_min_isr_partitions ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    if set when describing topics, only show partitions whose isr count is equal to the configured minimum. Not supported with the --zookeeper option.
    Property Attributes
    • default ⇒ false
    

71
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 71

property :AtMinIsrPartitions, type: [ TrueClass, FalseClass ], default: false
  • #topics_with_overrides ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    if set when describing topics, only show topics that have overridden configs
    Property Attributes
    • default ⇒ false
    

74
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 74

property :TopicsWithOverrides, type: [ TrueClass, FalseClass ], default: false
  • #unavailable_partitions ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    if set when describing topics, only show partitions whose leader is not available
    Property Attributes
    • default ⇒ false
    

76
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 76

property :UnavailablePartitions, type: [ TrueClass, FalseClass ], default: false
  • #under_min_isr_partitions ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    if set when describing topics, only show partitions whose isr count is less than the configured minimum. Not supported with the --zookeeper option.
    Property Attributes
    • default ⇒ false
    

80
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 80

property :UnderMinIsrPartitions, type: [ TrueClass, FalseClass ], default: false
  • #under_replication_partitions ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    if set when describing topics, only show under replicated partitions
    Property Attributes
    • default ⇒ false
    

83
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 83

property :UnderReplicationPartitions, type: [ TrueClass, FalseClass ], default: false
  • #config ⇒ Hash (Default Value: {})
    Additional config options to be passed to the kafka-topics() utility as key/value pairs
    Property Attributes
    • default ⇒ {}
    

86
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 86

property :Config, type: Hash, default: {}
  • #args ⇒ String (Default Value: "")
    Additional args to pass into CLI kafka-topics()
    Property Attributes
    • default ⇒ ""
    

89
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 89

property :args, type: String, default: ""
  • #parent ⇒ Confluent::Kafka::Broker
    The Broker this Topic is to be bootstrapped with
    Property Attributes
    • prop_name ⇒ :topics
    

92
    		 
    # File 'src/confluent-platform/lib/confluent-platform/model/acls.rb', line 92

property :parent, type: Confluent::Kafka::Broker, prop_name: :topics

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary collapse

Attributes included from MintPress::Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from MintPress::Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Acls

Returns a new instance of Acls.

Since:

  • 0.1.0

Instance Attribute Details

#installation ⇒ Confluent::Kafka::Installation

Returns the Confluent Platform installation.

Returns:

#name ⇒ Object

Since:

  • 0.1.0

Instance Method Details

#command_runner(cmdline) ⇒ Object

Since:

  • 0.1.0

#create ⇒ Object

Since:

  • 0.1.0

#delete ⇒ Object

Since:

  • 0.1.0

#describe ⇒ Object

Since:

  • 0.1.0

#exist? ⇒ Boolean

Alias of exists?

Returns:

  • (Boolean)

Since:

  • 0.1.0

#exists? ⇒ Boolean

Does the Topic exist

Returns:

  • (Boolean)

Since:

  • 0.1.0

#get_instance_variables ⇒ Object

Since:

  • 0.1.0

#harvest ⇒ Object

Harvest config into class properties

Since:

  • 0.1.0

#update ⇒ Object

Alter the number of partitions, replica assignment, and/or configuration for the topic.

Since:

  • 0.1.0

#usage ⇒ Object

Since:

  • 0.1.0

#validate ⇒ Object

Since:

  • 0.1.0