Class: DatadogAPIClient::V1::LogsPipeline

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/models/logs_pipeline.rb

Overview

Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. Note: These endpoints are only available for admin users. Make sure to use an application key created by an admin.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogsPipeline

Initializes the object



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/datadog_api_client/v1/models/logs_pipeline.rb', line 89

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::LogsPipeline` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::LogsPipeline`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'filter')
    self.filter = attributes[:'filter']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'is_enabled')
    self.is_enabled = attributes[:'is_enabled']
  end

  if attributes.key?(:'is_read_only')
    self.is_read_only = attributes[:'is_read_only']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'processors')
    if (value = attributes[:'processors']).is_a?(Array)
      self.processors = value
    end
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end
end

Instance Attribute Details

#filterObject

Returns the value of attribute filter.



26
27
28
# File 'lib/datadog_api_client/v1/models/logs_pipeline.rb', line 26

def filter
  @filter
end

#idObject

ID of the pipeline.



29
30
31
# File 'lib/datadog_api_client/v1/models/logs_pipeline.rb', line 29

def id
  @id
end

#is_enabledObject

Whether or not the pipeline is enabled.



32
33
34
# File 'lib/datadog_api_client/v1/models/logs_pipeline.rb', line 32

def is_enabled
  @is_enabled
end

#is_read_onlyObject

Whether or not the pipeline can be edited.



35
36
37
# File 'lib/datadog_api_client/v1/models/logs_pipeline.rb', line 35

def is_read_only
  @is_read_only
end

#nameObject

Name of the pipeline.



38
39
40
# File 'lib/datadog_api_client/v1/models/logs_pipeline.rb', line 38

def name
  @name
end

#processorsObject

Ordered list of processors in this pipeline.



41
42
43
# File 'lib/datadog_api_client/v1/models/logs_pipeline.rb', line 41

def processors
  @processors
end

#typeObject

Type of pipeline.



44
45
46
# File 'lib/datadog_api_client/v1/models/logs_pipeline.rb', line 44

def type
  @type
end