Interface Instance.ObservabilityInstanceConfigOrBuilder (0.43.0)

Version latest

• 0.43.0 (latest)
• 0.42.0
• 0.41.0
• 0.40.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface Instance.ObservabilityInstanceConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEnabled()

public abstract boolean getEnabled()

Observability feature status for an instance. This flag is turned "off" by default.

optional bool enabled = 1;

Returns
Type	Description
boolean	The enabled.

getMaxQueryStringLength()

public abstract int getMaxQueryStringLength()

Query string length. The default value is 10k.

optional int32 max_query_string_length = 5;

Returns
Type	Description
int	The maxQueryStringLength.

getPreserveComments()

public abstract boolean getPreserveComments()

Preserve comments in query string for an instance. This flag is turned "off" by default.

optional bool preserve_comments = 2;

Returns
Type	Description
boolean	The preserveComments.

getQueryPlansPerMinute()

public abstract int getQueryPlansPerMinute()

Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.

optional int32 query_plans_per_minute = 7;

Returns
Type	Description
int	The queryPlansPerMinute.

getRecordApplicationTags()

public abstract boolean getRecordApplicationTags()

Record application tags for an instance. This flag is turned "off" by default.

optional bool record_application_tags = 6;

Returns
Type	Description
boolean	The recordApplicationTags.

getTrackActiveQueries()

public abstract boolean getTrackActiveQueries()

Track actively running queries on the instance. If not set, this flag is "off" by default.

optional bool track_active_queries = 8;

Returns
Type	Description
boolean	The trackActiveQueries.

getTrackClientAddress()

public abstract boolean getTrackClientAddress()

Track client address for an instance. If not set, default value is "off".

optional bool track_client_address = 9;

Returns
Type	Description
boolean	The trackClientAddress.

getTrackWaitEventTypes()

public abstract boolean getTrackWaitEventTypes()

Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.

optional bool track_wait_event_types = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The trackWaitEventTypes.

getTrackWaitEvents()

public abstract boolean getTrackWaitEvents()

Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.

optional bool track_wait_events = 3;

Returns
Type	Description
boolean	The trackWaitEvents.

hasEnabled()

public abstract boolean hasEnabled()

Observability feature status for an instance. This flag is turned "off" by default.

optional bool enabled = 1;

Returns
Type	Description
boolean	Whether the enabled field is set.

hasMaxQueryStringLength()

public abstract boolean hasMaxQueryStringLength()

Query string length. The default value is 10k.

optional int32 max_query_string_length = 5;

Returns
Type	Description
boolean	Whether the maxQueryStringLength field is set.

hasPreserveComments()

public abstract boolean hasPreserveComments()

Preserve comments in query string for an instance. This flag is turned "off" by default.

optional bool preserve_comments = 2;

Returns
Type	Description
boolean	Whether the preserveComments field is set.

hasQueryPlansPerMinute()

public abstract boolean hasQueryPlansPerMinute()

Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.

optional int32 query_plans_per_minute = 7;

Returns
Type	Description
boolean	Whether the queryPlansPerMinute field is set.

hasRecordApplicationTags()

public abstract boolean hasRecordApplicationTags()

Record application tags for an instance. This flag is turned "off" by default.

optional bool record_application_tags = 6;

Returns
Type	Description
boolean	Whether the recordApplicationTags field is set.

hasTrackActiveQueries()

public abstract boolean hasTrackActiveQueries()

Track actively running queries on the instance. If not set, this flag is "off" by default.

optional bool track_active_queries = 8;

Returns
Type	Description
boolean	Whether the trackActiveQueries field is set.

hasTrackClientAddress()

public abstract boolean hasTrackClientAddress()

Track client address for an instance. If not set, default value is "off".

optional bool track_client_address = 9;

Returns
Type	Description
boolean	Whether the trackClientAddress field is set.

hasTrackWaitEventTypes()

public abstract boolean hasTrackWaitEventTypes()

Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.

optional bool track_wait_event_types = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the trackWaitEventTypes field is set.

hasTrackWaitEvents()

public abstract boolean hasTrackWaitEvents()

Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.

optional bool track_wait_events = 3;

Returns
Type	Description
boolean	Whether the trackWaitEvents field is set.