kinetica.AdminShowClusterOperationsResponse

A set of results returned by Kinetica.adminShowClusterOperations. More…

Inheritance diagram for kinetica.AdminShowClusterOperationsResponse:

Collaboration diagram for kinetica.AdminShowClusterOperationsResponse:

Classes
struct	AddRanks
	A set of string constants for the parameter AdminShowClusterOperationsResponse.add_ranks. More…

struct	AddRanksStatus
	A set of string constants for the parameter AdminShowClusterOperationsResponse.add_ranks_status. More…

struct	DryRun
	A set of string constants for the parameter AdminShowClusterOperationsResponse.dry_run. More…

struct	InProgress
	A set of string constants for the parameter AdminShowClusterOperationsResponse.in_progress. More…

struct	OverallStatus
	A set of string constants for the parameter AdminShowClusterOperationsResponse.overall_status. More…

struct	Rebalance
	A set of string constants for the parameter AdminShowClusterOperationsResponse.rebalance. More…

struct	RebalanceShardedData
	A set of string constants for the parameter AdminShowClusterOperationsResponse.rebalance_sharded_data. More…

struct	RebalanceShardedDataStatus
	A set of string constants for the parameter AdminShowClusterOperationsResponse.rebalance_sharded_data_status. More…

struct	RebalanceUnshardedData
	A set of string constants for the parameter AdminShowClusterOperationsResponse.rebalance_unsharded_data. More…

struct	RebalanceUnshardedDataStatus
	A set of string constants for the parameter AdminShowClusterOperationsResponse.rebalance_unsharded_data_status. More…

struct	RemoveRanks
	A set of string constants for the parameter AdminShowClusterOperationsResponse.remove_ranks. More…

struct	RemoveRanksStatus
	A set of string constants for the parameter AdminShowClusterOperationsResponse.remove_ranks_status. More…

struct	UserStopped
	A set of string constants for the parameter AdminShowClusterOperationsResponse.user_stopped. More…

Properties
int	history_index `[get, set]`
	The index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation.

int	history_size `[get, set]`
	Number of cluster operations executed to date.

bool	in_progress `[get, set]`
	Whether this cluster operation is currently in progress or not.

string	start_time `[get, set]`
	The start time of the cluster operation.

string	end_time `[get, set]`
	The end time of the cluster operation, if completed.

string	endpoint `[get, set]`
	The endpoint that initiated the cluster operation.

string	endpoint_schema `[get, set]`
	The schema for the original request.

string	overall_status `[get, set]`
	Overall success status of the operation.

bool	user_stopped `[get, set]`
	Whether a user stopped this operation at any point while in progress.

int	percent_complete `[get, set]`
	Percent complete of this entire operation.

bool	dry_run `[get, set]`
	Whether this operation was a dry run.

IList< string >	messages = new List<string>() `[get, set]`
	Updates and error messages if any.

bool	add_ranks `[get, set]`
	Whether adding ranks is (or was) part of this operation.

string	add_ranks_status `[get, set]`
	If this was a rank-adding operation, the add-specific status of the operation.

IList< int >	ranks_being_added = new List<int>() `[get, set]`
	The rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete.

IList< string >	rank_hosts = new List<string>() `[get, set]`
	The host IP addresses of the ranks being added, in the same order as the AdminShowClusterOperationsResponse.ranks_being_added list.

int	add_ranks_percent_complete `[get, set]`
	Current percent complete of the add ranks operation.

bool	remove_ranks `[get, set]`
	Whether removing ranks is (or was) part of this operation.

string	remove_ranks_status `[get, set]`
	If this was a rank-removing operation, the removal-specific status of the operation.

IList< int >	ranks_being_removed = new List<int>() `[get, set]`
	The ranks being removed, or that have been removed if the operation is completed.

int	remove_ranks_percent_complete `[get, set]`
	Current percent complete of the remove ranks operation.

bool	rebalance `[get, set]`
	Whether data and/or shard rebalancing is (or was) part of this operation.

bool	rebalance_unsharded_data `[get, set]`
	Whether rebalancing of unsharded data is (or was) part of this operation.

string	rebalance_unsharded_data_status `[get, set]`
	If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation.

int	unsharded_rebalance_percent_complete `[get, set]`
	Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.

bool	rebalance_sharded_data `[get, set]`
	Whether rebalancing of sharded data is (or was) part of this operation.

long	shard_array_version `[get, set]`
	Version of the shard array that is (or was) being rebalanced to.

string	rebalance_sharded_data_status `[get, set]`
	If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation.

int	num_shards_changing `[get, set]`
	Number of shards that will change as part of rebalance.

int	sharded_rebalance_percent_complete `[get, set]`
	Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.

IDictionary< string, string >	info = new Dictionary<string, string>() `[get, set]`
	Additional information.

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class.

Additional Inherited Members
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

Detailed Description

A set of results returned by Kinetica.adminShowClusterOperations.

Definition at line 54 of file AdminShowClusterOperations.cs.

Property Documentation

◆ add_ranks

bool kinetica.AdminShowClusterOperationsResponse.add_ranks

getset

Whether adding ranks is (or was) part of this operation.

Supported values:

true
false

Definition at line 436 of file AdminShowClusterOperations.cs.

◆ add_ranks_percent_complete

int kinetica.AdminShowClusterOperationsResponse.add_ranks_percent_complete

getset

Current percent complete of the add ranks operation.

Definition at line 481 of file AdminShowClusterOperations.cs.

◆ add_ranks_status

string kinetica.AdminShowClusterOperationsResponse.add_ranks_status

getset

If this was a rank-adding operation, the add-specific status of the operation.

Valid values are:

Definition at line 468 of file AdminShowClusterOperations.cs.

◆ dry_run

bool kinetica.AdminShowClusterOperationsResponse.dry_run

getset

Whether this operation was a dry run.

Supported values:

true
false

Definition at line 420 of file AdminShowClusterOperations.cs.

◆ end_time

string kinetica.AdminShowClusterOperationsResponse.end_time

getset

The end time of the cluster operation, if completed.

Definition at line 366 of file AdminShowClusterOperations.cs.

◆ endpoint

string kinetica.AdminShowClusterOperationsResponse.endpoint

getset

The endpoint that initiated the cluster operation.

Definition at line 369 of file AdminShowClusterOperations.cs.

◆ endpoint_schema

string kinetica.AdminShowClusterOperationsResponse.endpoint_schema

getset

The schema for the original request.

Definition at line 372 of file AdminShowClusterOperations.cs.

◆ history_index

int kinetica.AdminShowClusterOperationsResponse.history_index

getset

The index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation.

Definition at line 344 of file AdminShowClusterOperations.cs.

◆ history_size

int kinetica.AdminShowClusterOperationsResponse.history_size

getset

Number of cluster operations executed to date.

Definition at line 347 of file AdminShowClusterOperations.cs.

◆ in_progress

bool kinetica.AdminShowClusterOperationsResponse.in_progress

getset

Whether this cluster operation is currently in progress or not.

Supported values:

true
false

Definition at line 360 of file AdminShowClusterOperations.cs.

◆ info

IDictionary< string, string > kinetica.AdminShowClusterOperationsResponse.info = new Dictionary<string, string>()

getset

Additional information.

Definition at line 658 of file AdminShowClusterOperations.cs.

◆ messages

IList< string > kinetica.AdminShowClusterOperationsResponse.messages = new List<string>()

getset

Updates and error messages if any.

Definition at line 423 of file AdminShowClusterOperations.cs.

◆ num_shards_changing

int kinetica.AdminShowClusterOperationsResponse.num_shards_changing

getset

Number of shards that will change as part of rebalance.

Definition at line 651 of file AdminShowClusterOperations.cs.

◆ overall_status

string kinetica.AdminShowClusterOperationsResponse.overall_status

getset

Overall success status of the operation.

Supported values:

OK: The operation was successful, or, if still in progress, the operation is successful so far.
ERROR: An error occurred executing the operation.

Definition at line 392 of file AdminShowClusterOperations.cs.

◆ percent_complete

int kinetica.AdminShowClusterOperationsResponse.percent_complete

getset

Percent complete of this entire operation.

Definition at line 408 of file AdminShowClusterOperations.cs.

◆ rank_hosts

IList< string > kinetica.AdminShowClusterOperationsResponse.rank_hosts = new List<string>()

getset

The host IP addresses of the ranks being added, in the same order as the AdminShowClusterOperationsResponse.ranks_being_added list.

Definition at line 478 of file AdminShowClusterOperations.cs.

◆ ranks_being_added

IList< int > kinetica.AdminShowClusterOperationsResponse.ranks_being_added = new List<int>()

getset

The rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete.

Definition at line 472 of file AdminShowClusterOperations.cs.

◆ ranks_being_removed

IList< int > kinetica.AdminShowClusterOperationsResponse.ranks_being_removed = new List<int>()

getset

The ranks being removed, or that have been removed if the operation is completed.

Definition at line 530 of file AdminShowClusterOperations.cs.

◆ rebalance

bool kinetica.AdminShowClusterOperationsResponse.rebalance

getset

Whether data and/or shard rebalancing is (or was) part of this operation.

Supported values:

true
false

Definition at line 547 of file AdminShowClusterOperations.cs.

◆ rebalance_sharded_data

bool kinetica.AdminShowClusterOperationsResponse.rebalance_sharded_data

getset

Whether rebalancing of sharded data is (or was) part of this operation.

Supported values:

true
false

Definition at line 609 of file AdminShowClusterOperations.cs.

◆ rebalance_sharded_data_status

string kinetica.AdminShowClusterOperationsResponse.rebalance_sharded_data_status

getset

If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation.

Valid values are:

Definition at line 647 of file AdminShowClusterOperations.cs.

◆ rebalance_unsharded_data

bool kinetica.AdminShowClusterOperationsResponse.rebalance_unsharded_data

getset

Whether rebalancing of unsharded data is (or was) part of this operation.

Supported values:

true
false

Definition at line 560 of file AdminShowClusterOperations.cs.

◆ rebalance_unsharded_data_status

string kinetica.AdminShowClusterOperationsResponse.rebalance_unsharded_data_status

getset

If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation.

Valid values are:

Definition at line 592 of file AdminShowClusterOperations.cs.

◆ remove_ranks

bool kinetica.AdminShowClusterOperationsResponse.remove_ranks

getset

Whether removing ranks is (or was) part of this operation.

Supported values:

true
false

Definition at line 494 of file AdminShowClusterOperations.cs.

◆ remove_ranks_percent_complete

int kinetica.AdminShowClusterOperationsResponse.remove_ranks_percent_complete

getset

Current percent complete of the remove ranks operation.

Definition at line 534 of file AdminShowClusterOperations.cs.

◆ remove_ranks_status

string kinetica.AdminShowClusterOperationsResponse.remove_ranks_status

getset

If this was a rank-removing operation, the removal-specific status of the operation.

Valid values are:

Definition at line 526 of file AdminShowClusterOperations.cs.

◆ shard_array_version

long kinetica.AdminShowClusterOperationsResponse.shard_array_version

getset

Version of the shard array that is (or was) being rebalanced to.

Each change to the shard array results in the version number incrementing.

Definition at line 615 of file AdminShowClusterOperations.cs.

◆ sharded_rebalance_percent_complete

int kinetica.AdminShowClusterOperationsResponse.sharded_rebalance_percent_complete

getset

Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.

Definition at line 655 of file AdminShowClusterOperations.cs.

◆ start_time

string kinetica.AdminShowClusterOperationsResponse.start_time

getset

The start time of the cluster operation.

Definition at line 363 of file AdminShowClusterOperations.cs.

◆ unsharded_rebalance_percent_complete

int kinetica.AdminShowClusterOperationsResponse.unsharded_rebalance_percent_complete

getset

Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.

Definition at line 596 of file AdminShowClusterOperations.cs.

◆ user_stopped

bool kinetica.AdminShowClusterOperationsResponse.user_stopped

getset

Whether a user stopped this operation at any point while in progress.

Supported values:

true
false

Definition at line 405 of file AdminShowClusterOperations.cs.

The documentation for this class was generated from the following files:

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AdminShowClusterOperations.cs
Kinetica/Protocol/AdminShowClusterOperations.cs

​ Classes

​ Properties

​ Additional Inherited Members

​Detailed Description

​Property Documentation

​◆ add_ranks

​◆ add_ranks_percent_complete

​◆ add_ranks_status

​◆ dry_run

​◆ end_time

​◆ endpoint

​◆ endpoint_schema

​◆ history_index

​◆ history_size

​◆ in_progress

​◆ info

​◆ messages

​◆ num_shards_changing

​◆ overall_status

​◆ percent_complete

​◆ rank_hosts

​◆ ranks_being_added

​◆ ranks_being_removed

​◆ rebalance

​◆ rebalance_sharded_data

​◆ rebalance_sharded_data_status

​◆ rebalance_unsharded_data

​◆ rebalance_unsharded_data_status

​◆ remove_ranks

​◆ remove_ranks_percent_complete

​◆ remove_ranks_status

​◆ shard_array_version

​◆ sharded_rebalance_percent_complete

​◆ start_time

​◆ unsharded_rebalance_percent_complete

​◆ user_stopped

Classes

Properties

Additional Inherited Members

Detailed Description

Property Documentation

◆ add_ranks

◆ add_ranks_percent_complete

◆ add_ranks_status

◆ dry_run

◆ end_time

◆ endpoint

◆ endpoint_schema

◆ history_index

◆ history_size

◆ in_progress

◆ info

◆ messages

◆ num_shards_changing

◆ overall_status

◆ percent_complete

◆ rank_hosts

◆ ranks_being_added

◆ ranks_being_removed

◆ rebalance

◆ rebalance_sharded_data

◆ rebalance_sharded_data_status

◆ rebalance_unsharded_data

◆ rebalance_unsharded_data_status

◆ remove_ranks

◆ remove_ranks_percent_complete

◆ remove_ranks_status

◆ shard_array_version

◆ sharded_rebalance_percent_complete

◆ start_time

◆ unsharded_rebalance_percent_complete

◆ user_stopped