Skip to main content

Class AdminShowClusterOperationsResponse

java.lang.Object
com.gpudb.protocol.AdminShowClusterOperationsResponse
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class AdminShowClusterOperationsResponse extends Object implements org.apache.avro.generic.IndexedRecord
A set of results returned by GPUdb.adminShowClusterOperations.
  • Constructor Details

    • AdminShowClusterOperationsResponse

      public AdminShowClusterOperationsResponse()
      Constructs an AdminShowClusterOperationsResponse object with default parameters.
  • Method Details

    • getClassSchema

      public static org.apache.avro.Schema getClassSchema()
      This method supports the Avro framework and is not intended to be called directly by the user.
      Returns:
      The schema for the class.
    • getHistoryIndex

      public int getHistoryIndex()
      The index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation.
      Returns:
      The current value of historyIndex.
    • setHistoryIndex

      public AdminShowClusterOperationsResponse setHistoryIndex(int historyIndex)
      The index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation.
      Parameters:
      historyIndex - The new value for historyIndex.
      Returns:
      this to mimic the builder pattern.
    • getHistorySize

      public int getHistorySize()
      Number of cluster operations executed to date.
      Returns:
      The current value of historySize.
    • setHistorySize

      public AdminShowClusterOperationsResponse setHistorySize(int historySize)
      Number of cluster operations executed to date.
      Parameters:
      historySize - The new value for historySize.
      Returns:
      this to mimic the builder pattern.
    • getInProgress

      public boolean getInProgress()
      Whether this cluster operation is currently in progress or not. Supported values:
      • true
      • false
      Returns:
      The current value of inProgress.
    • setInProgress

      public AdminShowClusterOperationsResponse setInProgress(boolean inProgress)
      Whether this cluster operation is currently in progress or not. Supported values:
      • true
      • false
      Parameters:
      inProgress - The new value for inProgress.
      Returns:
      this to mimic the builder pattern.
    • getStartTime

      public String getStartTime()
      The start time of the cluster operation.
      Returns:
      The current value of startTime.
    • setStartTime

      public AdminShowClusterOperationsResponse setStartTime(String startTime)
      The start time of the cluster operation.
      Parameters:
      startTime - The new value for startTime.
      Returns:
      this to mimic the builder pattern.
    • getEndTime

      public String getEndTime()
      The end time of the cluster operation, if completed.
      Returns:
      The current value of endTime.
    • setEndTime

      public AdminShowClusterOperationsResponse setEndTime(String endTime)
      The end time of the cluster operation, if completed.
      Parameters:
      endTime - The new value for endTime.
      Returns:
      this to mimic the builder pattern.
    • getEndpoint

      public String getEndpoint()
      The endpoint that initiated the cluster operation.
      Returns:
      The current value of endpoint.
    • setEndpoint

      public AdminShowClusterOperationsResponse setEndpoint(String endpoint)
      The endpoint that initiated the cluster operation.
      Parameters:
      endpoint - The new value for endpoint.
      Returns:
      this to mimic the builder pattern.
    • getEndpointSchema

      public String getEndpointSchema()
      The schema for the original request.
      Returns:
      The current value of endpointSchema.
    • setEndpointSchema

      public AdminShowClusterOperationsResponse setEndpointSchema(String endpointSchema)
      The schema for the original request.
      Parameters:
      endpointSchema - The new value for endpointSchema.
      Returns:
      this to mimic the builder pattern.
    • getOverallStatus

      public String getOverallStatus()
      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.
      Returns:
      The current value of overallStatus.
    • setOverallStatus

      public AdminShowClusterOperationsResponse setOverallStatus(String overallStatus)
      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.
      Parameters:
      overallStatus - The new value for overallStatus.
      Returns:
      this to mimic the builder pattern.
    • getUserStopped

      public boolean getUserStopped()
      Whether a user stopped this operation at any point while in progress. Supported values:
      • true
      • false
      Returns:
      The current value of userStopped.
    • setUserStopped

      public AdminShowClusterOperationsResponse setUserStopped(boolean userStopped)
      Whether a user stopped this operation at any point while in progress. Supported values:
      • true
      • false
      Parameters:
      userStopped - The new value for userStopped.
      Returns:
      this to mimic the builder pattern.
    • getPercentComplete

      public int getPercentComplete()
      Percent complete of this entire operation.
      Returns:
      The current value of percentComplete.
    • setPercentComplete

      public AdminShowClusterOperationsResponse setPercentComplete(int percentComplete)
      Percent complete of this entire operation.
      Parameters:
      percentComplete - The new value for percentComplete.
      Returns:
      this to mimic the builder pattern.
    • getDryRun

      public boolean getDryRun()
      Whether this operation was a dry run. Supported values:
      • true
      • false
      Returns:
      The current value of dryRun.
    • setDryRun

      public AdminShowClusterOperationsResponse setDryRun(boolean dryRun)
      Whether this operation was a dry run. Supported values:
      • true
      • false
      Parameters:
      dryRun - The new value for dryRun.
      Returns:
      this to mimic the builder pattern.
    • getMessages

      public List<String> getMessages()
      Updates and error messages if any.
      Returns:
      The current value of messages.
    • setMessages

      public AdminShowClusterOperationsResponse setMessages(List<String> messages)
      Updates and error messages if any.
      Parameters:
      messages - The new value for messages.
      Returns:
      this to mimic the builder pattern.
    • getAddRanks

      public boolean getAddRanks()
      Whether adding ranks is (or was) part of this operation. Supported values:
      • true
      • false
      Returns:
      The current value of addRanks.
    • setAddRanks

      public AdminShowClusterOperationsResponse setAddRanks(boolean addRanks)
      Whether adding ranks is (or was) part of this operation. Supported values:
      • true
      • false
      Parameters:
      addRanks - The new value for addRanks.
      Returns:
      this to mimic the builder pattern.
    • getAddRanksStatus

      public String getAddRanksStatus()
      If this was a rank-adding operation, the add-specific status of the operation. Valid values are:
      Returns:
      The current value of addRanksStatus.
    • setAddRanksStatus

      public AdminShowClusterOperationsResponse setAddRanksStatus(String addRanksStatus)
      If this was a rank-adding operation, the add-specific status of the operation. Valid values are:
      Parameters:
      addRanksStatus - The new value for addRanksStatus.
      Returns:
      this to mimic the builder pattern.
    • getRanksBeingAdded

      public List<Integer> getRanksBeingAdded()
      The rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete.
      Returns:
      The current value of ranksBeingAdded.
    • setRanksBeingAdded

      public AdminShowClusterOperationsResponse setRanksBeingAdded(List<Integer> ranksBeingAdded)
      The rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete.
      Parameters:
      ranksBeingAdded - The new value for ranksBeingAdded.
      Returns:
      this to mimic the builder pattern.
    • getRankHosts

      public List<String> getRankHosts()
      The host IP addresses of the ranks being added, in the same order as the ranksBeingAdded list.
      Returns:
      The current value of rankHosts.
    • setRankHosts

      public AdminShowClusterOperationsResponse setRankHosts(List<String> rankHosts)
      The host IP addresses of the ranks being added, in the same order as the ranksBeingAdded list.
      Parameters:
      rankHosts - The new value for rankHosts.
      Returns:
      this to mimic the builder pattern.
    • getAddRanksPercentComplete

      public int getAddRanksPercentComplete()
      Current percent complete of the add ranks operation.
      Returns:
      The current value of addRanksPercentComplete.
    • setAddRanksPercentComplete

      public AdminShowClusterOperationsResponse setAddRanksPercentComplete(int addRanksPercentComplete)
      Current percent complete of the add ranks operation.
      Parameters:
      addRanksPercentComplete - The new value for addRanksPercentComplete.
      Returns:
      this to mimic the builder pattern.
    • getRemoveRanks

      public boolean getRemoveRanks()
      Whether removing ranks is (or was) part of this operation. Supported values:
      • true
      • false
      Returns:
      The current value of removeRanks.
    • setRemoveRanks

      public AdminShowClusterOperationsResponse setRemoveRanks(boolean removeRanks)
      Whether removing ranks is (or was) part of this operation. Supported values:
      • true
      • false
      Parameters:
      removeRanks - The new value for removeRanks.
      Returns:
      this to mimic the builder pattern.
    • getRemoveRanksStatus

      public String getRemoveRanksStatus()
      If this was a rank-removing operation, the removal-specific status of the operation. Valid values are:
      Returns:
      The current value of removeRanksStatus.
    • setRemoveRanksStatus

      public AdminShowClusterOperationsResponse setRemoveRanksStatus(String removeRanksStatus)
      If this was a rank-removing operation, the removal-specific status of the operation. Valid values are:
      Parameters:
      removeRanksStatus - The new value for removeRanksStatus.
      Returns:
      this to mimic the builder pattern.
    • getRanksBeingRemoved

      public List<Integer> getRanksBeingRemoved()
      The ranks being removed, or that have been removed if the operation is completed.
      Returns:
      The current value of ranksBeingRemoved.
    • setRanksBeingRemoved

      public AdminShowClusterOperationsResponse setRanksBeingRemoved(List<Integer> ranksBeingRemoved)
      The ranks being removed, or that have been removed if the operation is completed.
      Parameters:
      ranksBeingRemoved - The new value for ranksBeingRemoved.
      Returns:
      this to mimic the builder pattern.
    • getRemoveRanksPercentComplete

      public int getRemoveRanksPercentComplete()
      Current percent complete of the remove ranks operation.
      Returns:
      The current value of removeRanksPercentComplete.
    • setRemoveRanksPercentComplete

      public AdminShowClusterOperationsResponse setRemoveRanksPercentComplete(int removeRanksPercentComplete)
      Current percent complete of the remove ranks operation.
      Parameters:
      removeRanksPercentComplete - The new value for removeRanksPercentComplete.
      Returns:
      this to mimic the builder pattern.
    • getRebalance

      public boolean getRebalance()
      Whether data and/or shard rebalancing is (or was) part of this operation. Supported values:
      • true
      • false
      Returns:
      The current value of rebalance.
    • setRebalance

      public AdminShowClusterOperationsResponse setRebalance(boolean rebalance)
      Whether data and/or shard rebalancing is (or was) part of this operation. Supported values:
      • true
      • false
      Parameters:
      rebalance - The new value for rebalance.
      Returns:
      this to mimic the builder pattern.
    • getRebalanceUnshardedData

      public boolean getRebalanceUnshardedData()
      Whether rebalancing of unsharded data is (or was) part of this operation. Supported values:
      • true
      • false
      Returns:
      The current value of rebalanceUnshardedData.
    • setRebalanceUnshardedData

      public AdminShowClusterOperationsResponse setRebalanceUnshardedData(boolean rebalanceUnshardedData)
      Whether rebalancing of unsharded data is (or was) part of this operation. Supported values:
      • true
      • false
      Parameters:
      rebalanceUnshardedData - The new value for rebalanceUnshardedData.
      Returns:
      this to mimic the builder pattern.
    • getRebalanceUnshardedDataStatus

      public String getRebalanceUnshardedDataStatus()
      If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation. Valid values are:
      Returns:
      The current value of rebalanceUnshardedDataStatus.
    • setRebalanceUnshardedDataStatus

      public AdminShowClusterOperationsResponse setRebalanceUnshardedDataStatus(String rebalanceUnshardedDataStatus)
      If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation. Valid values are:
      Parameters:
      rebalanceUnshardedDataStatus - The new value for rebalanceUnshardedDataStatus.
      Returns:
      this to mimic the builder pattern.
    • getUnshardedRebalancePercentComplete

      public int getUnshardedRebalancePercentComplete()
      Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.
      Returns:
      The current value of unshardedRebalancePercentComplete.
    • setUnshardedRebalancePercentComplete

      public AdminShowClusterOperationsResponse setUnshardedRebalancePercentComplete(int unshardedRebalancePercentComplete)
      Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.
      Parameters:
      unshardedRebalancePercentComplete - The new value for unshardedRebalancePercentComplete.
      Returns:
      this to mimic the builder pattern.
    • getRebalanceShardedData

      public boolean getRebalanceShardedData()
      Whether rebalancing of sharded data is (or was) part of this operation. Supported values:
      • true
      • false
      Returns:
      The current value of rebalanceShardedData.
    • setRebalanceShardedData

      public AdminShowClusterOperationsResponse setRebalanceShardedData(boolean rebalanceShardedData)
      Whether rebalancing of sharded data is (or was) part of this operation. Supported values:
      • true
      • false
      Parameters:
      rebalanceShardedData - The new value for rebalanceShardedData.
      Returns:
      this to mimic the builder pattern.
    • getShardArrayVersion

      public long getShardArrayVersion()
      Version of the shard array that is (or was) being rebalanced to. Each change to the shard array results in the version number incrementing.
      Returns:
      The current value of shardArrayVersion.
    • setShardArrayVersion

      public AdminShowClusterOperationsResponse setShardArrayVersion(long shardArrayVersion)
      Version of the shard array that is (or was) being rebalanced to. Each change to the shard array results in the version number incrementing.
      Parameters:
      shardArrayVersion - The new value for shardArrayVersion.
      Returns:
      this to mimic the builder pattern.
    • getRebalanceShardedDataStatus

      public String getRebalanceShardedDataStatus()
      If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation. Valid values are:
      Returns:
      The current value of rebalanceShardedDataStatus.
    • setRebalanceShardedDataStatus

      public AdminShowClusterOperationsResponse setRebalanceShardedDataStatus(String rebalanceShardedDataStatus)
      If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation. Valid values are:
      Parameters:
      rebalanceShardedDataStatus - The new value for rebalanceShardedDataStatus.
      Returns:
      this to mimic the builder pattern.
    • getNumShardsChanging

      public int getNumShardsChanging()
      Number of shards that will change as part of rebalance.
      Returns:
      The current value of numShardsChanging.
    • setNumShardsChanging

      public AdminShowClusterOperationsResponse setNumShardsChanging(int numShardsChanging)
      Number of shards that will change as part of rebalance.
      Parameters:
      numShardsChanging - The new value for numShardsChanging.
      Returns:
      this to mimic the builder pattern.
    • getShardedRebalancePercentComplete

      public int getShardedRebalancePercentComplete()
      Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.
      Returns:
      The current value of shardedRebalancePercentComplete.
    • setShardedRebalancePercentComplete

      public AdminShowClusterOperationsResponse setShardedRebalancePercentComplete(int shardedRebalancePercentComplete)
      Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.
      Parameters:
      shardedRebalancePercentComplete - The new value for shardedRebalancePercentComplete.
      Returns:
      this to mimic the builder pattern.
    • getInfo

      public Map<String,String> getInfo()
      Additional information.
      Returns:
      The current value of info.
    • setInfo

      Additional information.
      Parameters:
      info - The new value for info.
      Returns:
      this to mimic the builder pattern.
    • getSchema

      public org.apache.avro.Schema getSchema()
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      getSchema in interface org.apache.avro.generic.GenericContainer
      Returns:
      The schema object describing this class.
    • get

      public Object get(int index)
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      get in interface org.apache.avro.generic.IndexedRecord
      Parameters:
      index - the position of the field to get
      Returns:
      value of the field with the given index.
      Throws:
    • put

      public void put(int index, Object value)
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      put in interface org.apache.avro.generic.IndexedRecord
      Parameters:
      index - the position of the field to set
      value - the value to set
      Throws:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object