Class protos.google.cloud.sql.v1.SqlServerAuditConfig (0.8.0)

Represents a SqlServerAuditConfig.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1.ISqlServerAuditConfig);

Constructs a new SqlServerAuditConfig.

Parameter
Name Description
properties ISqlServerAuditConfig

Properties to set

Properties

bucket

public bucket: string;

SqlServerAuditConfig bucket.

kind

public kind: string;

SqlServerAuditConfig kind.

retentionInterval

public retentionInterval?: (google.protobuf.IDuration|null);

SqlServerAuditConfig retentionInterval.

uploadInterval

public uploadInterval?: (google.protobuf.IDuration|null);

SqlServerAuditConfig uploadInterval.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.ISqlServerAuditConfig): google.cloud.sql.v1.SqlServerAuditConfig;

Creates a new SqlServerAuditConfig instance using the specified properties.

Parameter
Name Description
properties ISqlServerAuditConfig

Properties to set

Returns
Type Description
SqlServerAuditConfig

SqlServerAuditConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.sql.v1.SqlServerAuditConfig;

Decodes a SqlServerAuditConfig 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
SqlServerAuditConfig

SqlServerAuditConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1.SqlServerAuditConfig;

Decodes a SqlServerAuditConfig message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SqlServerAuditConfig

SqlServerAuditConfig

encode(message, writer)

public static encode(message: google.cloud.sql.v1.ISqlServerAuditConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SqlServerAuditConfig message. Does not implicitly messages.

Parameters
Name Description
message ISqlServerAuditConfig

SqlServerAuditConfig 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.sql.v1.ISqlServerAuditConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISqlServerAuditConfig

SqlServerAuditConfig 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.sql.v1.SqlServerAuditConfig;

Creates a SqlServerAuditConfig 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
SqlServerAuditConfig

SqlServerAuditConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SqlServerAuditConfig

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 SqlServerAuditConfig to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.sql.v1.SqlServerAuditConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message SqlServerAuditConfig

SqlServerAuditConfig

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 a SqlServerAuditConfig 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