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

Inheritance diagram for AdminShowClusterOperationsResponse:

Collaboration diagram for AdminShowClusterOperationsResponse:

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

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

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

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

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

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

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

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

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

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

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

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

struct	UserStopped
	A set of string constants for the parameter 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. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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

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

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

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

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

Detailed Description

A set of results returned by Kinetica.adminShowClusterOperations.

Definition at line 54 of file AdminShowClusterOperations.cs.

Property Documentation

◆ add_ranks

bool AdminShowClusterOperationsResponse.add_ranks

getset

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

Supported values:

true
false

Definition at line 294 of file AdminShowClusterOperations.cs.

◆ add_ranks_percent_complete

int AdminShowClusterOperationsResponse.add_ranks_percent_complete

getset

Current percent complete of the add ranks operation.

Definition at line 331 of file AdminShowClusterOperations.cs.

◆ add_ranks_status

string 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 320 of file AdminShowClusterOperations.cs.

◆ dry_run

bool AdminShowClusterOperationsResponse.dry_run

getset

Whether this operation was a dry run.

Supported values:

true
false

Definition at line 278 of file AdminShowClusterOperations.cs.

◆ end_time

string AdminShowClusterOperationsResponse.end_time

getset

The end time of the cluster operation, if completed.

Definition at line 228 of file AdminShowClusterOperations.cs.

◆ endpoint

string AdminShowClusterOperationsResponse.endpoint

getset

The endpoint that initiated the cluster operation.

Definition at line 231 of file AdminShowClusterOperations.cs.

◆ endpoint_schema

string AdminShowClusterOperationsResponse.endpoint_schema

getset

The schema for the original request.

Definition at line 234 of file AdminShowClusterOperations.cs.

◆ history_index

int 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 206 of file AdminShowClusterOperations.cs.

◆ history_size

int AdminShowClusterOperationsResponse.history_size

getset

Number of cluster operations executed to date.

Definition at line 209 of file AdminShowClusterOperations.cs.

◆ in_progress

bool AdminShowClusterOperationsResponse.in_progress

getset

Whether this cluster operation is currently in progress or not.

Supported values:

true
false

Definition at line 222 of file AdminShowClusterOperations.cs.

◆ info

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

getset

Additional information.

Definition at line 500 of file AdminShowClusterOperations.cs.

◆ messages

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

getset

Updates and error messages if any.

Definition at line 281 of file AdminShowClusterOperations.cs.

◆ num_shards_changing

int AdminShowClusterOperationsResponse.num_shards_changing

getset

Number of shards that will change as part of rebalance.

Definition at line 493 of file AdminShowClusterOperations.cs.

◆ overall_status

string 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 250 of file AdminShowClusterOperations.cs.

◆ percent_complete

int AdminShowClusterOperationsResponse.percent_complete

getset

Percent complete of this entire operation.

Definition at line 266 of file AdminShowClusterOperations.cs.

◆ rank_hosts

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

getset

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

Definition at line 328 of file AdminShowClusterOperations.cs.

◆ ranks_being_added

IList<int> 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 324 of file AdminShowClusterOperations.cs.

◆ ranks_being_removed

IList<int> 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 374 of file AdminShowClusterOperations.cs.

◆ rebalance

bool AdminShowClusterOperationsResponse.rebalance

getset

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

Supported values:

true
false

Definition at line 391 of file AdminShowClusterOperations.cs.

◆ rebalance_sharded_data

bool AdminShowClusterOperationsResponse.rebalance_sharded_data

getset

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

Supported values:

true
false

Definition at line 452 of file AdminShowClusterOperations.cs.

◆ rebalance_sharded_data_status

string 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 489 of file AdminShowClusterOperations.cs.

◆ rebalance_unsharded_data

bool AdminShowClusterOperationsResponse.rebalance_unsharded_data

getset

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

Supported values:

true
false

Definition at line 404 of file AdminShowClusterOperations.cs.

◆ rebalance_unsharded_data_status

string 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 435 of file AdminShowClusterOperations.cs.

◆ remove_ranks

bool AdminShowClusterOperationsResponse.remove_ranks

getset

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

Supported values:

true
false

Definition at line 344 of file AdminShowClusterOperations.cs.

◆ remove_ranks_percent_complete

int AdminShowClusterOperationsResponse.remove_ranks_percent_complete

getset

Current percent complete of the remove ranks operation.

Definition at line 378 of file AdminShowClusterOperations.cs.

◆ remove_ranks_status

string 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 370 of file AdminShowClusterOperations.cs.

◆ shard_array_version

long 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 458 of file AdminShowClusterOperations.cs.

◆ sharded_rebalance_percent_complete

int AdminShowClusterOperationsResponse.sharded_rebalance_percent_complete

getset

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

Definition at line 497 of file AdminShowClusterOperations.cs.

◆ start_time

string AdminShowClusterOperationsResponse.start_time

getset

The start time of the cluster operation.

Definition at line 225 of file AdminShowClusterOperations.cs.

◆ unsharded_rebalance_percent_complete

int AdminShowClusterOperationsResponse.unsharded_rebalance_percent_complete

getset

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

Definition at line 439 of file AdminShowClusterOperations.cs.

◆ user_stopped

bool AdminShowClusterOperationsResponse.user_stopped

getset

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

Supported values:

true
false

Definition at line 263 of file AdminShowClusterOperations.cs.

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

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