Class PerformanceCaptureConfig (0.1.0)

public final class PerformanceCaptureConfig extends GeneratedMessage implements PerformanceCaptureConfigOrBuilder

Performance capture configuration.

Protobuf type google.cloud.sql.v1beta4.PerformanceCaptureConfig

Static Fields

CPU_UTILIZATION_THRESHOLD_PERCENT_FIELD_NUMBER

public static final int CPU_UTILIZATION_THRESHOLD_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

HISTORY_LIST_LENGTH_THRESHOLD_COUNT_FIELD_NUMBER

public static final int HISTORY_LIST_LENGTH_THRESHOLD_COUNT_FIELD_NUMBER
Field Value
Type Description
int

MEMORY_USAGE_THRESHOLD_PERCENT_FIELD_NUMBER

public static final int MEMORY_USAGE_THRESHOLD_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

PROBE_THRESHOLD_FIELD_NUMBER

public static final int PROBE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

PROBING_INTERVAL_SECONDS_FIELD_NUMBER

public static final int PROBING_INTERVAL_SECONDS_FIELD_NUMBER
Field Value
Type Description
int

RUNNING_THREADS_THRESHOLD_FIELD_NUMBER

public static final int RUNNING_THREADS_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

SECONDS_BEHIND_SOURCE_THRESHOLD_FIELD_NUMBER

public static final int SECONDS_BEHIND_SOURCE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

SEMAPHORE_WAIT_THRESHOLD_COUNT_FIELD_NUMBER

public static final int SEMAPHORE_WAIT_THRESHOLD_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_DURATION_THRESHOLD_FIELD_NUMBER

public static final int TRANSACTION_DURATION_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_KILL_EXCLUDED_USER_HOSTS_FIELD_NUMBER

public static final int TRANSACTION_KILL_EXCLUDED_USER_HOSTS_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_KILL_THRESHOLD_SECONDS_FIELD_NUMBER

public static final int TRANSACTION_KILL_THRESHOLD_SECONDS_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_KILL_TYPE_FIELD_NUMBER

public static final int TRANSACTION_KILL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_LOCK_WAIT_THRESHOLD_COUNT_FIELD_NUMBER

public static final int TRANSACTION_LOCK_WAIT_THRESHOLD_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PerformanceCaptureConfig getDefaultInstance()
Returns
Type Description
PerformanceCaptureConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PerformanceCaptureConfig.Builder newBuilder()
Returns
Type Description
PerformanceCaptureConfig.Builder

newBuilder(PerformanceCaptureConfig prototype)

public static PerformanceCaptureConfig.Builder newBuilder(PerformanceCaptureConfig prototype)
Parameter
Name Description
prototype PerformanceCaptureConfig
Returns
Type Description
PerformanceCaptureConfig.Builder

parseDelimitedFrom(InputStream input)

public static PerformanceCaptureConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PerformanceCaptureConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PerformanceCaptureConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PerformanceCaptureConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PerformanceCaptureConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PerformanceCaptureConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PerformanceCaptureConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PerformanceCaptureConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PerformanceCaptureConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PerformanceCaptureConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PerformanceCaptureConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PerformanceCaptureConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PerformanceCaptureConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PerformanceCaptureConfig> parser()
Returns
Type Description
Parser<PerformanceCaptureConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCpuUtilizationThresholdPercent()

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

getDefaultInstanceForType()

public PerformanceCaptureConfig getDefaultInstanceForType()
Returns
Type Description
PerformanceCaptureConfig

getEnabled()

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

getParserForType()

public Parser<PerformanceCaptureConfig> getParserForType()
Returns
Type Description
Parser<PerformanceCaptureConfig>
Overrides

getProbeThreshold()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTransactionDurationThreshold()

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the transactionKillExcludedUserHosts.

getTransactionKillThresholdSeconds()

public 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 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.v1beta4.PerformanceCaptureConfig.TransactionKillType transaction_kill_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PerformanceCaptureConfig.TransactionKillType

The transactionKillType.

getTransactionKillTypeValue()

public 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.v1beta4.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 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 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 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 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 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 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 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 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 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 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 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 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 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.v1beta4.PerformanceCaptureConfig.TransactionKillType transaction_kill_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the transactionKillType field is set.

hasTransactionLockWaitThresholdCount()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PerformanceCaptureConfig.Builder newBuilderForType()
Returns
Type Description
PerformanceCaptureConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected PerformanceCaptureConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PerformanceCaptureConfig.Builder
Overrides

toBuilder()

public PerformanceCaptureConfig.Builder toBuilder()
Returns
Type Description
PerformanceCaptureConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException