Module: Constants

Defined in:

lib/ibm_appconfiguration_ruby_sdk/configurations/internal/constants.rb

Overview

This file defines the various constants used by the SDK.

Constant Summary

MAX_NUMBER_OF_RETRIES =

Maximum number of retries for API requests

3

STATUS_CODE_OK =

HTTP Status codes

200

STATUS_CODE_ACCEPTED =

202

CUSTOM_SOCKET_CLOSE_REASON_CODE =

Socket constants

4001

SOCKET_CONNECTION_ERROR =

"Socket connection error"

SOCKET_LOST_ERROR =

"Socket connection lost"

SOCKET_CONNECTION_CLOSE =

"Socket connection is closed"

SOCKET_INCOMING_DATA =

"Received data from socket"

SOCKET_MESSAGE_RECEIVED =

"Message received from server"

SOCKET_CALLBACK =

"Message passed to handler"

SOCKET_MESSAGE_ERROR =

"Message received from server is invalid"

SOCKET_CONNECTION_SUCCESS =

"Successfully connected to App Configuration server"

APPCONFIGURATION_CLIENT_EMITTER =

"configurationUpdate"

REGION_ERROR =

Error messages

"Provide a valid region in App Configuration init"

GUID_ERROR =

"Provide a valid guid in App Configuration init"

APIKEY_ERROR =

"Provide a valid apiKey in App Configuration init"

COLLECTION_ID_VALUE_ERROR =

"Provide a valid collectionId in App Configuration setContext method."

ENVIRONMENT_ID_VALUE_ERROR =

"Provide a valid environmentId in App Configuration setContext method."

COLLECTION_ID_ERROR =

"Invalid action in App Configuration. This action can be performed only after a successful initialization."

COLLECTION_INIT_ERROR =

"Invalid action in App Configuration. This action can be performed only after a successful initialization and setting the context."

INVALID_OPTIONS_PARAMTER =

"options param passed to setContext is invalid. Should be a Hash"

CONFIGURATION_FILE_NOT_FOUND_ERROR =

"bootstrapFile parameter should be provided while liveConfigUpdateEnabled is false during initialization."

PERSISTENT_CACHE_OPTION_ERROR =

"setContext: [options.persistentCacheDirectory]. Invalid value -"

BOOTSTRAP_FILEPATH_OPTION_ERROR =

"setContext: [options.bootstrapFile]. Invalid value -"

LIVE_CONFIG_UPDATE_OPTION_ERROR =

"setContext: [options.liveConfigUpdateEnabled]. Invalid value -"

BOOTSTRAP_FILEPATH_NOT_FOUND_ERROR =

"setContext: [options.bootstrapFile] parameter should be provided when [options.liveConfigUpdateEnabled] is false."

NO_INTERNET_CONNECTION_ERROR =

"Check for network connectivity failed. Re-checking..."

INVALID_ENTITY_ID =

"Invalid entityId passed to"

SINGLETON_EXCEPTION =

"Initialize object first"

DEFAULT_SEGMENT_ID =

Default values

"$$null$$"

DEFAULT_ENTITY_ID =

"$$null$$"

DEFAULT_USAGE_LIMIT =

10

DEFAULT_ROLLOUT_PERCENTAGE =

"$default"

DEFAULT_FEATURE_VALUE =

"$default"

DEFAULT_PROPERTY_VALUE =

"$default"

INVALID_SECRET_MANAGER_CLIENT_MESSAGE =

Secret Manager

"Secret Manager object passed to getSecret method is null or undefined."

SECRETREF =

"SECRETREF"

SUCCESSFULLY_FETCHED_THE_CONFIGURATIONS =

Success messages

"Successfully fetched the configurations"

SUCCESSFULLY_POSTED_METERING_DATA =

"Successfully posted metering data"

SUCCESSFULLY_POSTED_EXPERIMENT_EVALUATION_EVENTS =

"Successfully posted evaluation events"

SUCCESSFULLY_POSTED_EXPERIMENT_METRIC_EVENTS =

"Successfully posted metric events"

ERROR_POSTING_METERING_DATA =

Error messages for posting data

"Error while posting metering data"

ERROR_POSTING_EXPERIMENT_EVALUATION_EVENTS =

"Error while posting evaluation events"

ERROR_POSTING_EXPERIMENT_METRIC_EVENTS =

"Error while posting metric events"

ERROR_NO_WRITE_PERMISSION =

"Persistent cache directory provided doesn't have write permission. Make sure the directory has required access."

INPUT_PARAMETER_NOT_BOOLEAN =

"Input parameter passed to usePrivateEndpoint() method is not boolean. Default value will be used."

MANUAL =

Rollout types

"MANUAL"

PROGRESSIVE =

"PROGRESSIVE"

DELIMITER =

Delimiter

"\u001F"