Class Instance.ObservabilityInstanceConfig (0.43.0)

public static final class Instance.ObservabilityInstanceConfig extends GeneratedMessageV3 implements Instance.ObservabilityInstanceConfigOrBuilder

Observability Instance specific configuration.

Protobuf type google.cloud.alloydb.v1alpha.Instance.ObservabilityInstanceConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Instance.ObservabilityInstanceConfig

Static Fields

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

MAX_QUERY_STRING_LENGTH_FIELD_NUMBER

public static final int MAX_QUERY_STRING_LENGTH_FIELD_NUMBER
Field Value
Type Description
int

PRESERVE_COMMENTS_FIELD_NUMBER

public static final int PRESERVE_COMMENTS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_PLANS_PER_MINUTE_FIELD_NUMBER

public static final int QUERY_PLANS_PER_MINUTE_FIELD_NUMBER
Field Value
Type Description
int

RECORD_APPLICATION_TAGS_FIELD_NUMBER

public static final int RECORD_APPLICATION_TAGS_FIELD_NUMBER
Field Value
Type Description
int

TRACK_ACTIVE_QUERIES_FIELD_NUMBER

public static final int TRACK_ACTIVE_QUERIES_FIELD_NUMBER
Field Value
Type Description
int

TRACK_CLIENT_ADDRESS_FIELD_NUMBER

public static final int TRACK_CLIENT_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

TRACK_WAIT_EVENTS_FIELD_NUMBER

public static final int TRACK_WAIT_EVENTS_FIELD_NUMBER
Field Value
Type Description
int

TRACK_WAIT_EVENT_TYPES_FIELD_NUMBER

public static final int TRACK_WAIT_EVENT_TYPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Instance.ObservabilityInstanceConfig getDefaultInstance()
Returns
Type Description
Instance.ObservabilityInstanceConfig

getDescriptor()

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

newBuilder()

public static Instance.ObservabilityInstanceConfig.Builder newBuilder()
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

newBuilder(Instance.ObservabilityInstanceConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static Instance.ObservabilityInstanceConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Instance.ObservabilityInstanceConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Instance.ObservabilityInstanceConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Instance.ObservabilityInstanceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Instance.ObservabilityInstanceConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Instance.ObservabilityInstanceConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Instance.ObservabilityInstanceConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Instance.ObservabilityInstanceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Instance.ObservabilityInstanceConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Instance.ObservabilityInstanceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Instance.ObservabilityInstanceConfig> parser()
Returns
Type Description
Parser<ObservabilityInstanceConfig>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Instance.ObservabilityInstanceConfig getDefaultInstanceForType()
Returns
Type Description
Instance.ObservabilityInstanceConfig

getEnabled()

public 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 int getMaxQueryStringLength()

Query string length. The default value is 10k.

optional int32 max_query_string_length = 5;

Returns
Type Description
int

The maxQueryStringLength.

getParserForType()

public Parser<Instance.ObservabilityInstanceConfig> getParserForType()
Returns
Type Description
Parser<ObservabilityInstanceConfig>
Overrides

getPreserveComments()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTrackActiveQueries()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Instance.ObservabilityInstanceConfig.Builder newBuilderForType()
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.ObservabilityInstanceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Instance.ObservabilityInstanceConfig.Builder toBuilder()
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

writeTo(CodedOutputStream output)

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