Class Instance.ObservabilityInstanceConfig.Builder (0.43.0)

public static final class Instance.ObservabilityInstanceConfig.Builder extends GeneratedMessageV3.Builder<Instance.ObservabilityInstanceConfig.Builder> implements Instance.ObservabilityInstanceConfigOrBuilder

Observability Instance specific configuration.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Instance.ObservabilityInstanceConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

build()

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

buildPartial()

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

clear()

public Instance.ObservabilityInstanceConfig.Builder clear()
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

clearEnabled()

public Instance.ObservabilityInstanceConfig.Builder clearEnabled()

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

optional bool enabled = 1;

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Instance.ObservabilityInstanceConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

clearMaxQueryStringLength()

public Instance.ObservabilityInstanceConfig.Builder clearMaxQueryStringLength()

Query string length. The default value is 10k.

optional int32 max_query_string_length = 5;

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Instance.ObservabilityInstanceConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

clearPreserveComments()

public Instance.ObservabilityInstanceConfig.Builder clearPreserveComments()

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

optional bool preserve_comments = 2;

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clearQueryPlansPerMinute()

public Instance.ObservabilityInstanceConfig.Builder clearQueryPlansPerMinute()

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
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clearRecordApplicationTags()

public Instance.ObservabilityInstanceConfig.Builder clearRecordApplicationTags()

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

optional bool record_application_tags = 6;

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clearTrackActiveQueries()

public Instance.ObservabilityInstanceConfig.Builder clearTrackActiveQueries()

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
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clearTrackClientAddress()

public Instance.ObservabilityInstanceConfig.Builder clearTrackClientAddress()

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

optional bool track_client_address = 9;

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clearTrackWaitEventTypes()

public Instance.ObservabilityInstanceConfig.Builder clearTrackWaitEventTypes()

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
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clearTrackWaitEvents()

public Instance.ObservabilityInstanceConfig.Builder clearTrackWaitEvents()

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
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

clone()

public Instance.ObservabilityInstanceConfig.Builder clone()
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Instance.ObservabilityInstanceConfig other)

public Instance.ObservabilityInstanceConfig.Builder mergeFrom(Instance.ObservabilityInstanceConfig other)
Parameter
Name Description
other Instance.ObservabilityInstanceConfig
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Instance.ObservabilityInstanceConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Instance.ObservabilityInstanceConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Instance.ObservabilityInstanceConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

setEnabled(boolean value)

public Instance.ObservabilityInstanceConfig.Builder setEnabled(boolean value)

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

optional bool enabled = 1;

Parameter
Name Description
value boolean

The enabled to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Instance.ObservabilityInstanceConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

setMaxQueryStringLength(int value)

public Instance.ObservabilityInstanceConfig.Builder setMaxQueryStringLength(int value)

Query string length. The default value is 10k.

optional int32 max_query_string_length = 5;

Parameter
Name Description
value int

The maxQueryStringLength to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setPreserveComments(boolean value)

public Instance.ObservabilityInstanceConfig.Builder setPreserveComments(boolean value)

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

optional bool preserve_comments = 2;

Parameter
Name Description
value boolean

The preserveComments to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setQueryPlansPerMinute(int value)

public Instance.ObservabilityInstanceConfig.Builder setQueryPlansPerMinute(int value)

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;

Parameter
Name Description
value int

The queryPlansPerMinute to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setRecordApplicationTags(boolean value)

public Instance.ObservabilityInstanceConfig.Builder setRecordApplicationTags(boolean value)

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

optional bool record_application_tags = 6;

Parameter
Name Description
value boolean

The recordApplicationTags to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Instance.ObservabilityInstanceConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides

setTrackActiveQueries(boolean value)

public Instance.ObservabilityInstanceConfig.Builder setTrackActiveQueries(boolean value)

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

optional bool track_active_queries = 8;

Parameter
Name Description
value boolean

The trackActiveQueries to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setTrackClientAddress(boolean value)

public Instance.ObservabilityInstanceConfig.Builder setTrackClientAddress(boolean value)

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

optional bool track_client_address = 9;

Parameter
Name Description
value boolean

The trackClientAddress to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setTrackWaitEventTypes(boolean value)

public Instance.ObservabilityInstanceConfig.Builder setTrackWaitEventTypes(boolean value)

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];

Parameter
Name Description
value boolean

The trackWaitEventTypes to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setTrackWaitEvents(boolean value)

public Instance.ObservabilityInstanceConfig.Builder setTrackWaitEvents(boolean value)

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;

Parameter
Name Description
value boolean

The trackWaitEvents to set.

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Instance.ObservabilityInstanceConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder
Overrides