Class protos.google.logging.v2.LogBucket (10.1.11)

Represents a LogBucket.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.logging.v2.ILogBucket);

Constructs a new LogBucket.

Parameter

Name	Description
properties	`ILogBucket` Properties to set

Properties

cmekSettings

public cmekSettings?: (google.logging.v2.ICmekSettings|null);

LogBucket cmekSettings.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

LogBucket createTime.

description

public description: string;

LogBucket description.

lifecycleState

public lifecycleState: (google.logging.v2.LifecycleState|keyof typeof google.logging.v2.LifecycleState);

LogBucket lifecycleState.

locked

public locked: boolean;

LogBucket locked.

name

public name: string;

LogBucket name.

restrictedFields

public restrictedFields: string[];

LogBucket restrictedFields.

retentionDays

public retentionDays: number;

LogBucket retentionDays.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

LogBucket updateTime.

Methods

create(properties)

public static create(properties?: google.logging.v2.ILogBucket): google.logging.v2.LogBucket;

Creates a new LogBucket instance using the specified properties.

Parameter

Name	Description
properties	`ILogBucket` Properties to set

Returns

Type	Description
google.logging.v2.LogBucket	LogBucket instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.logging.v2.LogBucket;

Decodes a LogBucket message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.logging.v2.LogBucket	LogBucket

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.logging.v2.LogBucket;

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.logging.v2.LogBucket	LogBucket

encode(message, writer)

public static encode(message: google.logging.v2.ILogBucket, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified LogBucket message. Does not implicitly messages.

Parameters

Name	Description
message	`ILogBucket` LogBucket 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.logging.v2.ILogBucket, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ILogBucket` LogBucket 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.logging.v2.LogBucket;

Creates a LogBucket 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
google.logging.v2.LogBucket	LogBucket

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for LogBucket

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.logging.v2.LogBucket, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.logging.v2.LogBucket` LogBucket
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 LogBucket 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