Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 Client class InsightsConfig.
Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.
Generated from protobuf message google.cloud.sql.v1beta4.InsightsConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ query_insights_enabled |
bool
Whether Query Insights feature is enabled. |
↳ record_client_address |
bool
Whether Query Insights will record client address when enabled. |
↳ record_application_tags |
bool
Whether Query Insights will record application tags from query when enabled. |
↳ query_string_length |
Google\Protobuf\Int32Value
Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. |
↳ query_plans_per_minute |
Google\Protobuf\Int32Value
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. |
getQueryInsightsEnabled
Whether Query Insights feature is enabled.
| Returns | |
|---|---|
| Type | Description |
bool | |
setQueryInsightsEnabled
Whether Query Insights feature is enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRecordClientAddress
Whether Query Insights will record client address when enabled.
| Returns | |
|---|---|
| Type | Description |
bool | |
setRecordClientAddress
Whether Query Insights will record client address when enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRecordApplicationTags
Whether Query Insights will record application tags from query when enabled.
| Returns | |
|---|---|
| Type | Description |
bool | |
setRecordApplicationTags
Whether Query Insights will record application tags from query when enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryStringLength
Maximum query length stored in bytes. Default value: 1024 bytes.
Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int32Value|null | |
hasQueryStringLength
clearQueryStringLength
getQueryStringLengthValue
Returns the unboxed value from getQueryStringLength()
Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
| Returns | |
|---|---|
| Type | Description |
int|null | |
setQueryStringLength
Maximum query length stored in bytes. Default value: 1024 bytes.
Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int32Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setQueryStringLengthValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
| Parameter | |
|---|---|
| Name | Description |
var |
int|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryPlansPerMinute
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int32Value|null | |
hasQueryPlansPerMinute
clearQueryPlansPerMinute
getQueryPlansPerMinuteValue
Returns the unboxed value from getQueryPlansPerMinute()
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
| Returns | |
|---|---|
| Type | Description |
int|null | |
setQueryPlansPerMinute
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int32Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setQueryPlansPerMinuteValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
Number of query execution plans captured by Insights per minute for all queries combined. Default is 5.
| Parameter | |
|---|---|
| Name | Description |
var |
int|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |