kinetica.AdminShowClusterOperationsResponse Class Reference

A set of results returned by Kinetica.adminShowClusterOperations(int,IDictionary{string, string}). More...

Inheritance diagram for kinetica.AdminShowClusterOperationsResponse:

Collaboration diagram for kinetica.AdminShowClusterOperationsResponse:

Classes
struct	AddRanks
	Whether adding ranks is (or was) part of this operation. More...
struct	AddRanksStatus
	If this was a rank-adding operation, the add-specific status of the operation. More...
struct	DryRun
	Whether this operation was a dry run. More...
struct	InProgress
	Whether this cluster operation is currently in progress or not. More...
struct	OverallStatus
	Overall success status of the operation. More...
struct	Rebalance
	Whether data and/or shard rebalancing is (or was) part of this operation. More...
struct	RebalanceShardedData
	Whether rebalancing of sharded data is (or was) part of this operation. More...
struct	RebalanceShardedDataStatus
	If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation. More...
struct	RebalanceUnshardedData
	Whether rebalancing of unsharded data is (or was) part of this operation. More...
struct	RebalanceUnshardedDataStatus
	If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation. More...
struct	RemoveRanks
	Whether removing ranks is (or was) part of this operation. More...
struct	RemoveRanksStatus
	If this was a rank-removing operation, the removal-specific status of the operation. More...
struct	UserStopped
	Whether a user stopped this operation at any point while in progress. 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 [get, set]
	Updates and error messages if any. More...
bool	add_ranks = new List<string>() [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 [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<int>() [get, set]
	The host IP addresses of the ranks being added, in the same order as the <member name="ranks_being_added"> list. More...
int	add_ranks_percent_complete = new List<string>() [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 [get, set]
	The ranks being removed, or that have been removed if the operation is completed. More...
int	remove_ranks_percent_complete = new List<int>() [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 [get, set]
	Additional information. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

Additional Inherited Members
Public Member Functions inherited from kinetica.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 kinetica.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(int,IDictionary{string, string}).

Definition at line 63 of file AdminShowClusterOperations.cs.

Property Documentation

bool kinetica.AdminShowClusterOperationsResponse.add_ranks = new List<string>()

getset

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

Supported values:

• TRUE
• FALSE

Definition at line 519 of file AdminShowClusterOperations.cs.

int kinetica.AdminShowClusterOperationsResponse.add_ranks_percent_complete = new List<string>()

getset

Current percent complete of the add ranks operation.

Definition at line 560 of file AdminShowClusterOperations.cs.

string kinetica.AdminShowClusterOperationsResponse.add_ranks_status

getset

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

Valid values are:

• NOT_STARTED
• IN_PROGRESS
• INTERRUPTED
• COMPLETED_OK
• ERROR

Definition at line 546 of file AdminShowClusterOperations.cs.

bool kinetica.AdminShowClusterOperationsResponse.dry_run

getset

Whether this operation was a dry run.

Supported values:

• TRUE
• FALSE

Definition at line 502 of file AdminShowClusterOperations.cs.

string kinetica.AdminShowClusterOperationsResponse.end_time

getset

The end time of the cluster operation, if completed.

Definition at line 445 of file AdminShowClusterOperations.cs.

string kinetica.AdminShowClusterOperationsResponse.endpoint

getset

The endpoint that initiated the cluster operation.

Definition at line 449 of file AdminShowClusterOperations.cs.

string kinetica.AdminShowClusterOperationsResponse.endpoint_schema

getset

The schema for the original request.

Definition at line 452 of file AdminShowClusterOperations.cs.

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

int kinetica.AdminShowClusterOperationsResponse.history_size

getset

Number of cluster operations executed to date.

Definition at line 423 of file AdminShowClusterOperations.cs.

bool kinetica.AdminShowClusterOperationsResponse.in_progress

getset

Whether this cluster operation is currently in progress or not.

Supported values:

• TRUE
• FALSE

Definition at line 438 of file AdminShowClusterOperations.cs.

IDictionary<string, string> kinetica.AdminShowClusterOperationsResponse.info

getset

Additional information.

Definition at line 728 of file AdminShowClusterOperations.cs.

IList<string> kinetica.AdminShowClusterOperationsResponse.messages

getset

Updates and error messages if any.

Definition at line 505 of file AdminShowClusterOperations.cs.

int kinetica.AdminShowClusterOperationsResponse.num_shards_changing

getset

Number of shards that will change as part of rebalance.

Definition at line 721 of file AdminShowClusterOperations.cs.

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

int kinetica.AdminShowClusterOperationsResponse.percent_complete

getset

Percent complete of this entire operation.

Definition at line 488 of file AdminShowClusterOperations.cs.

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

getset

The host IP addresses of the ranks being added, in the same order as the <member name="ranks_being_added"> list.

Definition at line 556 of file AdminShowClusterOperations.cs.

IList<int> kinetica.AdminShowClusterOperationsResponse.ranks_being_added

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

IList<int> kinetica.AdminShowClusterOperationsResponse.ranks_being_removed

getset

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

Definition at line 605 of file AdminShowClusterOperations.cs.

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

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

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:

• NOT_STARTED
• IN_PROGRESS
• INTERRUPTED
• COMPLETED_OK
• ERROR

Definition at line 717 of file AdminShowClusterOperations.cs.

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

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:

• NOT_STARTED
• IN_PROGRESS
• INTERRUPTED
• COMPLETED_OK
• ERROR

Definition at line 666 of file AdminShowClusterOperations.cs.

bool kinetica.AdminShowClusterOperationsResponse.remove_ranks

getset

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

Supported values:

• TRUE
• FALSE

Definition at line 574 of file AdminShowClusterOperations.cs.

int kinetica.AdminShowClusterOperationsResponse.remove_ranks_percent_complete = new List<int>()

getset

Current percent complete of the remove ranks operation.

Definition at line 609 of file AdminShowClusterOperations.cs.

string kinetica.AdminShowClusterOperationsResponse.remove_ranks_status

getset

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

Valid values are:

• NOT_STARTED
• IN_PROGRESS
• INTERRUPTED
• COMPLETED_OK
• ERROR

Definition at line 601 of file AdminShowClusterOperations.cs.

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

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

string kinetica.AdminShowClusterOperationsResponse.start_time

getset

The start time of the cluster operation.

Definition at line 441 of file AdminShowClusterOperations.cs.

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

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

---

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

• Kinetica/Protocol/AdminShowClusterOperations.cs