Class: DatadogAPIClient::V2::ObservabilityPipelineWebsocketSource

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb

Overview

The websocket source ingests logs from a WebSocket server using the ws:// or wss:// protocol.

Supported pipeline types: logs.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



56
57
58
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 56

def additional_properties
  @additional_properties
end

#auth_strategy ⇒ Object

Authentication strategy for the WebSocket source connection.



27
28
29
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 27

def auth_strategy
  @auth_strategy
end

#custom_key ⇒ Object

Name of the environment variable or secret that holds the custom authorization header value. Used when auth_strategy is custom.



30
31
32
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 30

def custom_key
  @custom_key
end

#decoding ⇒ Object

The decoding format used to interpret incoming logs.



33
34
35
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 33

def decoding
  @decoding
end

#id ⇒ Object

The unique identifier for this component.



36
37
38
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 36

def id
  @id
end

#password_key ⇒ Object

Name of the environment variable or secret that holds the password. Used when auth_strategy is basic.



39
40
41
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 39

def password_key
  @password_key
end

#tls ⇒ Object

TLS configuration for the WebSocket source. Use enabled for standard wss:// connections, or with_client_cert to present a client certificate for mutual TLS.



42
43
44
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 42

def tls
  @tls
end

#token_key ⇒ Object

Name of the environment variable or secret that holds the bearer token. Used when auth_strategy is bearer.



45
46
47
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 45

def token_key
  @token_key
end

#type ⇒ Object

The source type. The value should always be websocket.



48
49
50
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 48

def type
  @type
end

#uri_key ⇒ Object

Name of the environment variable or secret that holds the WebSocket server URI (ws:// or wss://).



51
52
53
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 51

def uri_key
  @uri_key
end

#username_key ⇒ Object

Name of the environment variable or secret that holds the username. Used when auth_strategy is basic.



54
55
56
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_websocket_source.rb', line 54

def username_key
  @username_key
end