Class protos.google.cloud.alloydb.v1alpha.Instance.ObservabilityInstanceConfig (1.10.1)

Represents an ObservabilityInstanceConfig.

Package

@google-cloud/alloydb

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.alloydb.v1alpha.Instance.IObservabilityInstanceConfig);

Constructs a new ObservabilityInstanceConfig.

Parameter
Name Description
properties IObservabilityInstanceConfig

Properties to set

Properties

_enabled

public _enabled?: "enabled";

ObservabilityInstanceConfig _enabled.

_maxQueryStringLength

public _maxQueryStringLength?: "maxQueryStringLength";

ObservabilityInstanceConfig _maxQueryStringLength.

_preserveComments

public _preserveComments?: "preserveComments";

ObservabilityInstanceConfig _preserveComments.

_queryPlansPerMinute

public _queryPlansPerMinute?: "queryPlansPerMinute";

ObservabilityInstanceConfig _queryPlansPerMinute.

_recordApplicationTags

public _recordApplicationTags?: "recordApplicationTags";

ObservabilityInstanceConfig _recordApplicationTags.

_trackActiveQueries

public _trackActiveQueries?: "trackActiveQueries";

ObservabilityInstanceConfig _trackActiveQueries.

_trackClientAddress

public _trackClientAddress?: "trackClientAddress";

ObservabilityInstanceConfig _trackClientAddress.

_trackWaitEvents

public _trackWaitEvents?: "trackWaitEvents";

ObservabilityInstanceConfig _trackWaitEvents.

_trackWaitEventTypes

public _trackWaitEventTypes?: "trackWaitEventTypes";

ObservabilityInstanceConfig _trackWaitEventTypes.

enabled

public enabled?: (boolean|null);

ObservabilityInstanceConfig enabled.

maxQueryStringLength

public maxQueryStringLength?: (number|null);

ObservabilityInstanceConfig maxQueryStringLength.

preserveComments

public preserveComments?: (boolean|null);

ObservabilityInstanceConfig preserveComments.

queryPlansPerMinute

public queryPlansPerMinute?: (number|null);

ObservabilityInstanceConfig queryPlansPerMinute.

recordApplicationTags

public recordApplicationTags?: (boolean|null);

ObservabilityInstanceConfig recordApplicationTags.

trackActiveQueries

public trackActiveQueries?: (boolean|null);

ObservabilityInstanceConfig trackActiveQueries.

trackClientAddress

public trackClientAddress?: (boolean|null);

ObservabilityInstanceConfig trackClientAddress.

trackWaitEvents

public trackWaitEvents?: (boolean|null);

ObservabilityInstanceConfig trackWaitEvents.

trackWaitEventTypes

public trackWaitEventTypes?: (boolean|null);

ObservabilityInstanceConfig trackWaitEventTypes.

Methods

create(properties)

public static create(properties?: google.cloud.alloydb.v1alpha.Instance.IObservabilityInstanceConfig): google.cloud.alloydb.v1alpha.Instance.ObservabilityInstanceConfig;

Creates a new ObservabilityInstanceConfig instance using the specified properties.

Parameter
Name Description
properties IObservabilityInstanceConfig

Properties to set

Returns
Type Description
ObservabilityInstanceConfig

ObservabilityInstanceConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.alloydb.v1alpha.Instance.ObservabilityInstanceConfig;

Decodes an ObservabilityInstanceConfig message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
ObservabilityInstanceConfig

ObservabilityInstanceConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.alloydb.v1alpha.Instance.ObservabilityInstanceConfig;

Decodes an ObservabilityInstanceConfig message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ObservabilityInstanceConfig

ObservabilityInstanceConfig

encode(message, writer)

public static encode(message: google.cloud.alloydb.v1alpha.Instance.IObservabilityInstanceConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ObservabilityInstanceConfig message. Does not implicitly messages.

Parameters
Name Description
message IObservabilityInstanceConfig

ObservabilityInstanceConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.alloydb.v1alpha.Instance.IObservabilityInstanceConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ObservabilityInstanceConfig message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IObservabilityInstanceConfig

ObservabilityInstanceConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.alloydb.v1alpha.Instance.ObservabilityInstanceConfig;

Creates an ObservabilityInstanceConfig message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
ObservabilityInstanceConfig

ObservabilityInstanceConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ObservabilityInstanceConfig

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this ObservabilityInstanceConfig to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.alloydb.v1alpha.Instance.ObservabilityInstanceConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an ObservabilityInstanceConfig message. Also converts values to other types if specified.

Parameters
Name Description
message ObservabilityInstanceConfig

ObservabilityInstanceConfig

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an ObservabilityInstanceConfig message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not