Class protos.google.bigtable.admin.v2.GcRule (4.0.5)

Represents a GcRule.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.bigtable.admin.v2.IGcRule);

Constructs a new GcRule.

Parameter

Name	Description
properties	`google.bigtable.admin.v2.IGcRule` Properties to set

Properties

intersection

public intersection?: (google.bigtable.admin.v2.GcRule.IIntersection|null);

GcRule intersection.

maxAge

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

GcRule maxAge.

maxNumVersions

public maxNumVersions?: (number|null);

GcRule maxNumVersions.

rule

public rule?: ("maxNumVersions"|"maxAge"|"intersection"|"union");

GcRule rule.

union

public union?: (google.bigtable.admin.v2.GcRule.IUnion|null);

GcRule union.

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.IGcRule): google.bigtable.admin.v2.GcRule;

Creates a new GcRule instance using the specified properties.

Parameter

Name	Description
properties	`google.bigtable.admin.v2.IGcRule` Properties to set

Returns

Type	Description
google.bigtable.admin.v2.GcRule	GcRule instance

decode(reader, length)

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

Decodes a GcRule 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.bigtable.admin.v2.GcRule	GcRule

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.bigtable.admin.v2.GcRule;

Decodes a GcRule 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.bigtable.admin.v2.GcRule	GcRule

encode(message, writer)

public static encode(message: google.bigtable.admin.v2.IGcRule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GcRule message. Does not implicitly messages.

Parameters

Name	Description
message	`google.bigtable.admin.v2.IGcRule` GcRule 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.bigtable.admin.v2.IGcRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`google.bigtable.admin.v2.IGcRule` GcRule 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.bigtable.admin.v2.GcRule;

Creates a GcRule 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.bigtable.admin.v2.GcRule	GcRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GcRule

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.bigtable.admin.v2.GcRule` GcRule
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 GcRule 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