Class: Google::Apis::TrafficdirectorV2::DynamicListener

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/trafficdirector_v2/classes.rb,
generated/google/apis/trafficdirector_v2/representations.rb,
generated/google/apis/trafficdirector_v2/representations.rb

Overview

Describes a dynamically loaded listener via the LDS API. [#next-free-field: 6]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DynamicListener

Returns a new instance of DynamicListener.



314
315
316
 
# File 'generated/google/apis/trafficdirector_v2/classes.rb', line 314

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#active_state ⇒ Google::Apis::TrafficdirectorV2::DynamicListenerState

The listener state for any active listener by this name. These are listeners that are available to service data plane traffic. Corresponds to the JSON property activeState

Returns:



285
286
287
 
# File 'generated/google/apis/trafficdirector_v2/classes.rb', line 285

def active_state
  @active_state
end

#draining_state ⇒ Google::Apis::TrafficdirectorV2::DynamicListenerState

The listener state for any draining listener by this name. These are listeners that are currently undergoing draining in preparation to stop servicing data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the draining listeners should generally be discarded. Corresponds to the JSON property drainingState

Returns:



293
294
295
 
# File 'generated/google/apis/trafficdirector_v2/classes.rb', line 293

def draining_state
  @draining_state
end

#error_state ⇒ Google::Apis::TrafficdirectorV2::UpdateFailureState

Set if the last update failed, cleared after the next successful update. Corresponds to the JSON property errorState

Returns:



298
299
300
 
# File 'generated/google/apis/trafficdirector_v2/classes.rb', line 298

def error_state
  @error_state
end

#name ⇒ String

The name or unique id of this listener, pulled from the DynamicListenerState config. Corresponds to the JSON property name

Returns:

  • (String) 


304
305
306
 
# File 'generated/google/apis/trafficdirector_v2/classes.rb', line 304

def name
  @name
end

#warming_state ⇒ Google::Apis::TrafficdirectorV2::DynamicListenerState

The listener state for any warming listener by this name. These are listeners that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming listeners should generally be discarded. Corresponds to the JSON property warmingState

Returns:



312
313
314
 
# File 'generated/google/apis/trafficdirector_v2/classes.rb', line 312

def warming_state
  @warming_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



319
320
321
322
323
324
325
 
# File 'generated/google/apis/trafficdirector_v2/classes.rb', line 319

def update!(**args)
  @active_state = args[:active_state] if args.key?(:active_state)
  @draining_state = args[:draining_state] if args.key?(:draining_state)
  @error_state = args[:error_state] if args.key?(:error_state)
  @name = args[:name] if args.key?(:name)
  @warming_state = args[:warming_state] if args.key?(:warming_state)
end