Class protos.google.cloud.datacatalog.v1.UsageSignal (3.3.1)

Represents a UsageSignal.

Package

@google-cloud/datacatalog

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datacatalog.v1.IUsageSignal);

Constructs a new UsageSignal.

Parameter
NameDescription
properties IUsageSignal

Properties to set

Properties

_favoriteCount

public _favoriteCount?: "favoriteCount";

UsageSignal _favoriteCount.

commonUsageWithinTimeRange

public commonUsageWithinTimeRange: { [k: string]: google.cloud.datacatalog.v1.ICommonUsageStats };

UsageSignal commonUsageWithinTimeRange.

favoriteCount

public favoriteCount?: (number|Long|string|null);

UsageSignal favoriteCount.

updateTime

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

UsageSignal updateTime.

usageWithinTimeRange

public usageWithinTimeRange: { [k: string]: google.cloud.datacatalog.v1.IUsageStats };

UsageSignal usageWithinTimeRange.

Methods

create(properties)

public static create(properties?: google.cloud.datacatalog.v1.IUsageSignal): google.cloud.datacatalog.v1.UsageSignal;

Creates a new UsageSignal instance using the specified properties.

Parameter
NameDescription
properties IUsageSignal

Properties to set

Returns
TypeDescription
google.cloud.datacatalog.v1.UsageSignal

UsageSignal instance

decode(reader, length)

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

Decodes a UsageSignal message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.datacatalog.v1.UsageSignal

UsageSignal

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datacatalog.v1.UsageSignal

UsageSignal

encode(message, writer)

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

Encodes the specified UsageSignal message. Does not implicitly messages.

Parameters
NameDescription
message IUsageSignal

UsageSignal 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.cloud.datacatalog.v1.IUsageSignal, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IUsageSignal

UsageSignal 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.cloud.datacatalog.v1.UsageSignal;

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

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

Plain object

Returns
TypeDescription
google.cloud.datacatalog.v1.UsageSignal

UsageSignal

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UsageSignal

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.datacatalog.v1.UsageSignal

UsageSignal

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 UsageSignal 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