Interface PerformanceCaptureConfigOrBuilder (0.1.0)

public interface PerformanceCaptureConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCpuUtilizationThresholdPercent()

public abstract int getCpuUtilizationThresholdPercent()

Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from 10 to 99. Enter 0 to disable the check.

optional int32 cpu_utilization_threshold_percent = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The cpuUtilizationThresholdPercent.

getEnabled()

public abstract boolean getEnabled()

Optional. Enables or disables the performance capture feature.

optional bool enabled = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enabled.

getHistoryListLengthThresholdCount()

public abstract int getHistoryListLengthThresholdCount()

Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from 10000 to 10000000. Enter 0 to disable the check.

optional int32 history_list_length_threshold_count = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The historyListLengthThresholdCount.

getMemoryUsageThresholdPercent()

public abstract int getMemoryUsageThresholdPercent()

Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from 10 to 99. Enter 0 to disable the check.

optional int32 memory_usage_threshold_percent = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The memoryUsageThresholdPercent.

getProbeThreshold()

public abstract int getProbeThreshold()

Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.

optional int32 probe_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The probeThreshold.

getProbingIntervalSeconds()

public abstract int getProbingIntervalSeconds()

Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached.

optional int32 probing_interval_seconds = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The probingIntervalSeconds.

getRunningThreadsThreshold()

public abstract int getRunningThreadsThreshold()

Optional. Specifies the minimum number of MySQL Threads_running to trigger the performance capture on the primary instance.

optional int32 running_threads_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The runningThreadsThreshold.

getSecondsBehindSourceThreshold()

public abstract int getSecondsBehindSourceThreshold()

Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica.

optional int32 seconds_behind_source_threshold = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The secondsBehindSourceThreshold.

getSemaphoreWaitThresholdCount()

public abstract int getSemaphoreWaitThresholdCount()

Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from 10 to 10000. Enter 0 to disable the check.

optional int32 semaphore_wait_threshold_count = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The semaphoreWaitThresholdCount.

getTransactionDurationThreshold()

public abstract int getTransactionDurationThreshold()

Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.

optional int32 transaction_duration_threshold = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The transactionDurationThreshold.

getTransactionKillExcludedUserHosts(int index)

public abstract String getTransactionKillExcludedUserHosts(int index)

Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: ["app_user", "db_admin@10.1.2.3", "report_user@%"]

repeated string transaction_kill_excluded_user_hosts = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The transactionKillExcludedUserHosts at the given index.

getTransactionKillExcludedUserHostsBytes(int index)

public abstract ByteString getTransactionKillExcludedUserHostsBytes(int index)

Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: ["app_user", "db_admin@10.1.2.3", "report_user@%"]

repeated string transaction_kill_excluded_user_hosts = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the transactionKillExcludedUserHosts at the given index.

getTransactionKillExcludedUserHostsCount()

public abstract int getTransactionKillExcludedUserHostsCount()

Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: ["app_user", "db_admin@10.1.2.3", "report_user@%"]

repeated string transaction_kill_excluded_user_hosts = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of transactionKillExcludedUserHosts.

getTransactionKillExcludedUserHostsList()

public abstract List<String> getTransactionKillExcludedUserHostsList()

Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: ["app_user", "db_admin@10.1.2.3", "report_user@%"]

repeated string transaction_kill_excluded_user_hosts = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the transactionKillExcludedUserHosts.

getTransactionKillThresholdSeconds()

public abstract int getTransactionKillThresholdSeconds()

Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from 60 to 604800 (7 days). Enter 0 to disable. If enabled (i.e., > 0), this value must be greater than or equal to transaction_duration_threshold. Configurations where 0 < transaction_kill_threshold_seconds < transaction_duration_threshold will be rejected.

optional int32 transaction_kill_threshold_seconds = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The transactionKillThresholdSeconds.

getTransactionKillType()

public abstract PerformanceCaptureConfig.TransactionKillType getTransactionKillType()

Optional. Determines which transactions are allowed to be terminated when they exceed transaction_kill_threshold_seconds. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to READ_ONLY_TRANSACTIONS if unspecified.

optional .google.cloud.sql.v1.PerformanceCaptureConfig.TransactionKillType transaction_kill_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PerformanceCaptureConfig.TransactionKillType	The transactionKillType.

getTransactionKillTypeValue()

public abstract int getTransactionKillTypeValue()

Optional. Determines which transactions are allowed to be terminated when they exceed transaction_kill_threshold_seconds. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to READ_ONLY_TRANSACTIONS if unspecified.

optional .google.cloud.sql.v1.PerformanceCaptureConfig.TransactionKillType transaction_kill_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for transactionKillType.

getTransactionLockWaitThresholdCount()

public abstract int getTransactionLockWaitThresholdCount()

Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from 10 to 10000. Enter 0 to disable the check.

optional int32 transaction_lock_wait_threshold_count = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The transactionLockWaitThresholdCount.

hasCpuUtilizationThresholdPercent()

public abstract boolean hasCpuUtilizationThresholdPercent()

Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from 10 to 99. Enter 0 to disable the check.

optional int32 cpu_utilization_threshold_percent = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the cpuUtilizationThresholdPercent field is set.

hasEnabled()

public abstract boolean hasEnabled()

Optional. Enables or disables the performance capture feature.

optional bool enabled = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the enabled field is set.

hasHistoryListLengthThresholdCount()

public abstract boolean hasHistoryListLengthThresholdCount()

Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from 10000 to 10000000. Enter 0 to disable the check.

optional int32 history_list_length_threshold_count = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the historyListLengthThresholdCount field is set.

hasMemoryUsageThresholdPercent()

public abstract boolean hasMemoryUsageThresholdPercent()

Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from 10 to 99. Enter 0 to disable the check.

optional int32 memory_usage_threshold_percent = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the memoryUsageThresholdPercent field is set.

hasProbeThreshold()

public abstract boolean hasProbeThreshold()

Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.

optional int32 probe_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the probeThreshold field is set.

hasProbingIntervalSeconds()

public abstract boolean hasProbingIntervalSeconds()

Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached.

optional int32 probing_interval_seconds = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the probingIntervalSeconds field is set.

hasRunningThreadsThreshold()

public abstract boolean hasRunningThreadsThreshold()

Optional. Specifies the minimum number of MySQL Threads_running to trigger the performance capture on the primary instance.

optional int32 running_threads_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the runningThreadsThreshold field is set.

hasSecondsBehindSourceThreshold()

public abstract boolean hasSecondsBehindSourceThreshold()

Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica.

optional int32 seconds_behind_source_threshold = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the secondsBehindSourceThreshold field is set.

hasSemaphoreWaitThresholdCount()

public abstract boolean hasSemaphoreWaitThresholdCount()

Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from 10 to 10000. Enter 0 to disable the check.

optional int32 semaphore_wait_threshold_count = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the semaphoreWaitThresholdCount field is set.

hasTransactionDurationThreshold()

public abstract boolean hasTransactionDurationThreshold()

Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.

optional int32 transaction_duration_threshold = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the transactionDurationThreshold field is set.

hasTransactionKillThresholdSeconds()

public abstract boolean hasTransactionKillThresholdSeconds()

Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from 60 to 604800 (7 days). Enter 0 to disable. If enabled (i.e., > 0), this value must be greater than or equal to transaction_duration_threshold. Configurations where 0 < transaction_kill_threshold_seconds < transaction_duration_threshold will be rejected.

optional int32 transaction_kill_threshold_seconds = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the transactionKillThresholdSeconds field is set.

hasTransactionKillType()

public abstract boolean hasTransactionKillType()

Optional. Determines which transactions are allowed to be terminated when they exceed transaction_kill_threshold_seconds. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to READ_ONLY_TRANSACTIONS if unspecified.

optional .google.cloud.sql.v1.PerformanceCaptureConfig.TransactionKillType transaction_kill_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the transactionKillType field is set.

hasTransactionLockWaitThresholdCount()

public abstract boolean hasTransactionLockWaitThresholdCount()

Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from 10 to 10000. Enter 0 to disable the check.

optional int32 transaction_lock_wait_threshold_count = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the transactionLockWaitThresholdCount field is set.