Class protos.google.logging.v2.BucketMetadata (10.5.0)

Represents a BucketMetadata.

Package

@google-cloud/logging

Constructors

(constructor)(properties)

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

Constructs a new BucketMetadata.

Parameter
NameDescription
properties IBucketMetadata

Properties to set

Properties

createBucketRequest

public createBucketRequest?: (google.logging.v2.ICreateBucketRequest|null);

BucketMetadata createBucketRequest.

endTime

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

BucketMetadata endTime.

request

public request?: ("createBucketRequest"|"updateBucketRequest");

BucketMetadata request.

startTime

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

BucketMetadata startTime.

state

public state: (google.logging.v2.OperationState|keyof typeof google.logging.v2.OperationState);

BucketMetadata state.

updateBucketRequest

public updateBucketRequest?: (google.logging.v2.IUpdateBucketRequest|null);

BucketMetadata updateBucketRequest.

Methods

create(properties)

public static create(properties?: google.logging.v2.IBucketMetadata): google.logging.v2.BucketMetadata;

Creates a new BucketMetadata instance using the specified properties.

Parameter
NameDescription
properties IBucketMetadata

Properties to set

Returns
TypeDescription
BucketMetadata

BucketMetadata instance

decode(reader, length)

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

Decodes a BucketMetadata message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
BucketMetadata

BucketMetadata

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BucketMetadata

BucketMetadata

encode(message, writer)

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

Encodes the specified BucketMetadata message. Does not implicitly messages.

Parameters
NameDescription
message IBucketMetadata

BucketMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IBucketMetadata

BucketMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.logging.v2.BucketMetadata;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
BucketMetadata

BucketMetadata

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BucketMetadata

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this BucketMetadata to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message BucketMetadata

BucketMetadata

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a BucketMetadata message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not