Class: LaunchDarkly::Impl::DataSystem::Update Private

Inherits:
Object
  • Object
show all
Defined in:
lib/ldclient-rb/impl/data_system.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Update represents the results of a synchronizer’s ongoing sync method.

Since:

  • 5.5.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(state:, change_set: nil, error: nil, fallback_to_fdv1: false, environment_id: nil) ⇒ Update

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Update.

Parameters:

  • state (Symbol) —

    The state of the data source

  • change_set (ChangeSet, nil) (defaults to: nil) —

    The change set if available

  • error (LaunchDarkly::Interfaces::DataSource::ErrorInfo, nil) (defaults to: nil) —

    Error information if applicable

  • fallback_to_fdv1 (Boolean) (defaults to: false) —

    Whether to fall back to FDv1

  • environment_id (String, nil) (defaults to: nil) —

    The environment ID if available

Since:

  • 5.5.0



264
265
266
267
268
269
270
 
# File 'lib/ldclient-rb/impl/data_system.rb', line 264

def initialize(state:, change_set: nil, error: nil, fallback_to_fdv1: false, environment_id: nil)
  @state = state
  @change_set = change_set
  @error = error
  @fallback_to_fdv1 = fallback_to_fdv1
  @environment_id = environment_id
end

Instance Attribute Details

#change_set ⇒ ChangeSet? (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The change set if available.

Returns:

  • (ChangeSet, nil) —

    The change set if available

Since:

  • 5.5.0



245
246
247
 
# File 'lib/ldclient-rb/impl/data_system.rb', line 245

def change_set
  @change_set
end

#environment_id ⇒ String? (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The environment ID if available.

Returns:

  • (String, nil) —

    The environment ID if available

Since:

  • 5.5.0



255
256
257
 
# File 'lib/ldclient-rb/impl/data_system.rb', line 255

def environment_id
  @environment_id
end

#error ⇒ LaunchDarkly::Interfaces::DataSource::ErrorInfo? (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Error information if applicable.

Returns:

Since:

  • 5.5.0



248
249
250
 
# File 'lib/ldclient-rb/impl/data_system.rb', line 248

def error
  @error
end

#fallback_to_fdv1 ⇒ Boolean (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Whether the LaunchDarkly server has instructed the SDK to fall back to the FDv1 protocol.

Returns:

  • (Boolean) —

    Whether the LaunchDarkly server has instructed the SDK to fall back to the FDv1 protocol.

Since:

  • 5.5.0



252
253
254
 
# File 'lib/ldclient-rb/impl/data_system.rb', line 252

def fallback_to_fdv1
  @fallback_to_fdv1
end

#state ⇒ Symbol (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The state of the data source.

Returns:

  • (Symbol) —

    The state of the data source

Since:

  • 5.5.0



242
243
244
 
# File 'lib/ldclient-rb/impl/data_system.rb', line 242

def state
  @state
end