clc atomicreference

AtomicReference operations

Usage:

bash

clc atomicreference [command] [flags]

Commands

• clc atomicreference clear
• clc atomicreference compare-and-set
• clc atomicreference contains
• clc atomicreference destroy
• clc atomicreference get
• clc atomicreference get-and-set
• clc atomicreference is-null
• clc atomicreference set

clc atomicreference clear

Deletes the AtomicReference value.

Usage:

bash

clc atomicreference clear [flags]

Parameters:

Parameter	Required	Description	Default
--name, -n	Optional	Name of the AtomicReference.	default

Global parameters

Parameter	Description	Default
--config, -c	Name of the configuration or path to the configuration file in YAML format.	The following locations are tried in order for the existence of config.yaml Current working directory The parent directory of the clc executable $CLC_HOME/default directory
--format, -f	Set the output format csv delimited: By tab characters json table	Interactive mode: table Non-interactive mode: delimited
--log.level	Set the log level, one of: debug info warning error	info
--log.path	Set the log path. Use stderr to log to the screen (stderr).	$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.
--quiet, -q	Prevent displaying unnecessary output.	false
--verbose	Enable output with more information.	false
--timeout	Timeout for operation to complete. The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following: ms: milliseconds s: seconds m: minutes h: hours Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified. The following are a few of the valid DURATIONs: 5: 5 seconds 5s: 5 seconds 10000ms: 10000 milliseconds 10_000_000ms: 10000000 milliseconds warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

bash

clc atomicreference --name ref1 clear ref1

clc atomicreference compare-and-set

Sets the value for the given key if it has the expected value.

Usage:

bash

clc atomicreference compare-and-set [expected value] [new value] [flags]

Parameters:

Parameter	Required	Description	Default
--name, -n	Optional	Name of the AtomicReference.	default
expected value,	Required	Old value of the atomic reference.	N/A
new value,	Required	New value of the atomic reference.	N/A
--value-type, -v	Optional	Data type of the value. One of: string, bool, json, i8, i16, i32, i64, f32, f64	string
--show-type	Optional	Add a type column to the output.	false

Global parameters

Parameter	Description	Default
--config, -c	Name of the configuration or path to the configuration file in YAML format.	The following locations are tried in order for the existence of config.yaml Current working directory The parent directory of the clc executable $CLC_HOME/default directory
--format, -f	Set the output format csv delimited: By tab characters json table	Interactive mode: table Non-interactive mode: delimited
--log.level	Set the log level, one of: debug info warning error	info
--log.path	Set the log path. Use stderr to log to the screen (stderr).	$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.
--quiet, -q	Prevent displaying unnecessary output.	false
--verbose	Enable output with more information.	false
--timeout	Timeout for operation to complete. The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following: ms: milliseconds s: seconds m: minutes h: hours Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified. The following are a few of the valid DURATIONs: 5: 5 seconds 5s: 5 seconds 10000ms: 10000 milliseconds 10_000_000ms: 10000000 milliseconds warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

bash

clc atomicreference --name ref1 compare-and-set previous-value next-value

clc atomicreference contains

Checks whether the AtomcReference has the given value.

Usage:

bash

clc atomicreference contains [value] [flags]

Parameters:

Parameter	Required	Description	Default
--name, -n	Optional	Name of the AtomicReference.	default
value,	Required	Value to be checked for existence.	N/A
--value-type, -v	Optional	Data type of the value. One of: string, bool, json, i8, i16, i32, i64, f32, f64	string
--show-type	Optional	Add a type column to the output.	false

Global parameters

Parameter	Description	Default
--config, -c	Name of the configuration or path to the configuration file in YAML format.	The following locations are tried in order for the existence of config.yaml Current working directory The parent directory of the clc executable $CLC_HOME/default directory
--format, -f	Set the output format csv delimited: By tab characters json table	Interactive mode: table Non-interactive mode: delimited
--log.level	Set the log level, one of: debug info warning error	info
--log.path	Set the log path. Use stderr to log to the screen (stderr).	$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.
--quiet, -q	Prevent displaying unnecessary output.	false
--verbose	Enable output with more information.	false
--timeout	Timeout for operation to complete. The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following: ms: milliseconds s: seconds m: minutes h: hours Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified. The following are a few of the valid DURATIONs: 5: 5 seconds 5s: 5 seconds 10000ms: 10000 milliseconds 10_000_000ms: 10000000 milliseconds warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

bash

clc atomicreference --name ref1 contains my-value

clc atomicreference get

Gets the AtomicReference value.

Usage:

bash

clc atomicreference get [value] [flags]

Parameters:

Parameter	Required	Description	Default
--name, -n	Optional	Name of the AtomicReference.	default
value,	Required	Value to be checked for existence.	N/A
--value-type, -v	Optional	Data type of the value. One of: string, bool, json, i8, i16, i32, i64, f32, f64	string
--show-type	Optional	Add a type column to the output.	false

Global parameters

Parameter	Description	Default
--config, -c	Name of the configuration or path to the configuration file in YAML format.	The following locations are tried in order for the existence of config.yaml Current working directory The parent directory of the clc executable $CLC_HOME/default directory
--format, -f	Set the output format csv delimited: By tab characters json table	Interactive mode: table Non-interactive mode: delimited
--log.level	Set the log level, one of: debug info warning error	info
--log.path	Set the log path. Use stderr to log to the screen (stderr).	$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.
--quiet, -q	Prevent displaying unnecessary output.	false
--verbose	Enable output with more information.	false
--timeout	Timeout for operation to complete. The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following: ms: milliseconds s: seconds m: minutes h: hours Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified. The following are a few of the valid DURATIONs: 5: 5 seconds 5s: 5 seconds 10000ms: 10000 milliseconds 10_000_000ms: 10000000 milliseconds warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

bash

clc atomicreference --name ref1 get my-value

clc atomicreference get-and-set

Sets a value in the given AtomicReference and returns the previous value.

Usage:

bash

clc atomicreference get-and-set [value] [flags]

Parameters:

Parameter	Required	Description	Default
--name, -n	Optional	Name of the AtomicReference.	default
value,	Required	Value to be checked for existence.	N/A
--value-type, -v	Optional	Data type of the value. One of: string, bool, json, i8, i16, i32, i64, f32, f64	string
--show-type	Optional	Add a type column to the output.	false

Global parameters

Parameter	Description	Default
--config, -c	Name of the configuration or path to the configuration file in YAML format.	The following locations are tried in order for the existence of config.yaml Current working directory The parent directory of the clc executable $CLC_HOME/default directory
--format, -f	Set the output format csv delimited: By tab characters json table	Interactive mode: table Non-interactive mode: delimited
--log.level	Set the log level, one of: debug info warning error	info
--log.path	Set the log path. Use stderr to log to the screen (stderr).	$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.
--quiet, -q	Prevent displaying unnecessary output.	false
--verbose	Enable output with more information.	false
--timeout	Timeout for operation to complete. The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following: ms: milliseconds s: seconds m: minutes h: hours Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified. The following are a few of the valid DURATIONs: 5: 5 seconds 5s: 5 seconds 10000ms: 10000 milliseconds 10_000_000ms: 10000000 milliseconds warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

bash

clc atomicreference --name ref1 get-and-set my-value

clc atomicreference is-null

Checks whether the stored value in the reference is null.

Usage:

bash

clc atomicreference is-null [flags]

Parameters:

Parameter	Required	Description	Default
--name, -n	Optional	Name of the AtomicReference.	default
--show-type	Optional	Add a type column to the output.	false

Global parameters

Parameter	Description	Default
--config, -c	Name of the configuration or path to the configuration file in YAML format.	The following locations are tried in order for the existence of config.yaml Current working directory The parent directory of the clc executable $CLC_HOME/default directory
--format, -f	Set the output format csv delimited: By tab characters json table	Interactive mode: table Non-interactive mode: delimited
--log.level	Set the log level, one of: debug info warning error	info
--log.path	Set the log path. Use stderr to log to the screen (stderr).	$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.
--quiet, -q	Prevent displaying unnecessary output.	false
--verbose	Enable output with more information.	false
--timeout	Timeout for operation to complete. The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following: ms: milliseconds s: seconds m: minutes h: hours Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified. The following are a few of the valid DURATIONs: 5: 5 seconds 5s: 5 seconds 10000ms: 10000 milliseconds 10_000_000ms: 10000000 milliseconds warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

bash

clc atomicreference --name ref1 is-null

clc atomicreference set

Sets a value in the given AtomicReference.

Usage:

bash

clc atomicreference set [value] [flags]

Parameters:

Parameter	Required	Description	Default
--name, -n	Optional	Name of the AtomicReference.	default
value,	Required	Value to be checked for existence.	N/A
--value-type, -v	Optional	Data type of the value. One of: string, bool, json, i8, i16, i32, i64, f32, f64	string

Global parameters

Parameter	Description	Default
--config, -c	Name of the configuration or path to the configuration file in YAML format.	The following locations are tried in order for the existence of config.yaml Current working directory The parent directory of the clc executable $CLC_HOME/default directory
--format, -f	Set the output format csv delimited: By tab characters json table	Interactive mode: table Non-interactive mode: delimited
--log.level	Set the log level, one of: debug info warning error	info
--log.path	Set the log path. Use stderr to log to the screen (stderr).	$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.
--quiet, -q	Prevent displaying unnecessary output.	false
--verbose	Enable output with more information.	false
--timeout	Timeout for operation to complete. The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following: ms: milliseconds s: seconds m: minutes h: hours Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified. The following are a few of the valid DURATIONs: 5: 5 seconds 5s: 5 seconds 10000ms: 10000 milliseconds 10_000_000ms: 10000000 milliseconds warning This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Example:

bash

clc atomicreference --name ref1 set my-value

clc atomicreference destroy

Deletes the AtomicReference and related data. Once destroyed, an AtomicReference with the same name cannot be used.

Usage:

bash

clc atomicreference destroy [flags]

Parameters:

Parameter	Required	Description	Default
--name, -n	Optional	Name of the atomic reference.	default
--yes	Optional	Skip confirming the destroy operation.	false