Interface GemParameters

All Superinterfaces:
io.sbk.params.ActionParameter, io.sbk.params.Parameters, io.sbk.params.ThreadTypeParameter
All Known Subinterfaces:
GemParameterOptions
All Known Implementing Classes:
SbkGemParameters
public sealed interface GemParameters extends io.sbk.params.Parameters permits GemParameterOptions
Interface GemParameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    ConnectionConfig[]
    getConnections()
    to get ssh connections.
    String
    getJavaDir()
    Get the optional remote Java home.
    String
    getLocalHost()
    to get local host.
    String
    getSbkDir()
    to get Sbk directory.
    int
    getSbmIdleSleepMilliSeconds()
    to get SBM idle milliseconds sleep.
    int
    getSbmPort()
    to get SBM port number.
    BigDecimal
    getTotalThroughput()
    Get the aggregate throughput requested for all remote SBK clients.
    boolean
    isLocalHostOption()
    Check whether the SBM callback address was explicitly supplied.
    boolean
    isPackagesCleanup()
    Check whether every inactive non-current SBK-GEM-managed runtime and local cached bundle should be removed.
    boolean
    isTotalRecordsOption()
    Check whether the record value is an aggregate across all remote SBK clients.
    boolean
    isTotalThroughputOption()
    Check whether throughput is an aggregate across all remote SBK clients.

    Methods inherited from interface io.sbk.params.ActionParameter

    getAction

    Methods inherited from interface io.sbk.params.Parameters

    getIdleSleepMilliSeconds, getIdleTimeoutSeconds, getReadersCount, getReadersStep, getReadersStepSeconds, getRecordSize, getRecordsPerSec, getRecordsPerSync, getTimeoutMS, getTotalRecords, getTotalSecondsToRun, getWritersCount, getWritersStep, getWritersStepSeconds, isMpscQueueEnabled

    Methods inherited from interface io.sbk.params.ThreadTypeParameter

    getThreadType

  • Method Details

    • getConnections

      ConnectionConfig[] getConnections()
      to get ssh connections.
      Returns:
      SshConnection.

    • getSbkDir

      String getSbkDir()
      to get Sbk directory.
      Returns:
      Sbk directory.

    • getLocalHost

      String getLocalHost()
      to get local host.
      Returns:
      the local host.

    • isLocalHostOption

      boolean isLocalHostOption()
      Check whether the SBM callback address was explicitly supplied.
      Returns:
      true when -localhost was supplied by the user or YML launcher

    • getSbmPort

      int getSbmPort()
      to get SBM port number.
      Returns:
      SBM port number.

    • getSbmIdleSleepMilliSeconds

      int getSbmIdleSleepMilliSeconds()
      to get SBM idle milliseconds sleep.
      Returns:
      SBM idle milliseconds sleep.

    • isTotalRecordsOption

      boolean isTotalRecordsOption()
      Check whether the record value is an aggregate across all remote SBK clients.
      Returns:
      true when -totalrecords was supplied

    • isTotalThroughputOption

      boolean isTotalThroughputOption()
      Check whether throughput is an aggregate across all remote SBK clients.
      Returns:
      true when -totalthroughput was supplied

    • getTotalThroughput

      BigDecimal getTotalThroughput()
      Get the aggregate throughput requested for all remote SBK clients.
      Returns:
      aggregate throughput in MB/s

    • getJavaDir

      String getJavaDir()
      Get the optional remote Java home.
      Returns:
      remote Java home, or an empty value when automatic discovery is used

    • isPackagesCleanup

      boolean isPackagesCleanup()
      Check whether every inactive non-current SBK-GEM-managed runtime and local cached bundle should be removed.
      Returns:
      true when managed runtime cleanup is enabled