Class protos.google.bigtable.v2.RowFilter (3.6.0)

Represents a RowFilter.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

constructor(properties?: google.bigtable.v2.IRowFilter);

Constructs a new RowFilter.

Parameter

Name	Description
properties	`IRowFilter` Properties to set

Properties

applyLabelTransformer

public applyLabelTransformer?: (string|null);

RowFilter applyLabelTransformer.

Property Value

Type	Description
(string\|null)

blockAllFilter

public blockAllFilter?: (boolean|null);

RowFilter blockAllFilter.

Property Value

Type	Description
(boolean\|null)

cellsPerColumnLimitFilter

public cellsPerColumnLimitFilter?: (number|null);

RowFilter cellsPerColumnLimitFilter.

Property Value

Type	Description
(number\|null)

cellsPerRowLimitFilter

public cellsPerRowLimitFilter?: (number|null);

RowFilter cellsPerRowLimitFilter.

Property Value

Type	Description
(number\|null)

cellsPerRowOffsetFilter

public cellsPerRowOffsetFilter?: (number|null);

RowFilter cellsPerRowOffsetFilter.

Property Value

Type	Description
(number\|null)

chain

public chain?: (google.bigtable.v2.RowFilter.IChain|null);

RowFilter chain.

Property Value

Type	Description
(google.bigtable.v2.RowFilter.IChain\|null)

columnQualifierRegexFilter

public columnQualifierRegexFilter?: (Uint8Array|string|null);

RowFilter columnQualifierRegexFilter.

Property Value

Type	Description
(Uint8Array\|string\|null)

columnRangeFilter

public columnRangeFilter?: (google.bigtable.v2.IColumnRange|null);

RowFilter columnRangeFilter.

Property Value

Type	Description
(google.bigtable.v2.IColumnRange\|null)

condition

public condition?: (google.bigtable.v2.RowFilter.ICondition|null);

RowFilter condition.

Property Value

Type	Description
(google.bigtable.v2.RowFilter.ICondition\|null)

familyNameRegexFilter

public familyNameRegexFilter?: (string|null);

RowFilter familyNameRegexFilter.

Property Value

Type	Description
(string\|null)

filter

public filter?: ("chain"|"interleave"|"condition"|"sink"|"passAllFilter"|"blockAllFilter"|"rowKeyRegexFilter"|"rowSampleFilter"|"familyNameRegexFilter"|"columnQualifierRegexFilter"|"columnRangeFilter"|"timestampRangeFilter"|"valueRegexFilter"|"valueRangeFilter"|"cellsPerRowOffsetFilter"|"cellsPerRowLimitFilter"|"cellsPerColumnLimitFilter"|"stripValueTransformer"|"applyLabelTransformer");

RowFilter filter.

Property Value

Type	Description
("chain"\|"interleave"\|"condition"\|"sink"\|"passAllFilter"\|"blockAllFilter"\|"rowKeyRegexFilter"\|"rowSampleFilter"\|"familyNameRegexFilter"\|"columnQualifierRegexFilter"\|"columnRangeFilter"\|"timestampRangeFilter"\|"valueRegexFilter"\|"valueRangeFilter"\|"cellsPerRowOffsetFilter"\|"cellsPerRowLimitFilter"\|"cellsPerColumnLimitFilter"\|"stripValueTransformer"\|"applyLabelTransformer")

interleave

public interleave?: (google.bigtable.v2.RowFilter.IInterleave|null);

RowFilter interleave.

Property Value

Type	Description
(google.bigtable.v2.RowFilter.IInterleave\|null)

passAllFilter

public passAllFilter?: (boolean|null);

RowFilter passAllFilter.

Property Value

Type	Description
(boolean\|null)

rowKeyRegexFilter

public rowKeyRegexFilter?: (Uint8Array|string|null);

RowFilter rowKeyRegexFilter.

Property Value

Type	Description
(Uint8Array\|string\|null)

rowSampleFilter

public rowSampleFilter?: (number|null);

RowFilter rowSampleFilter.

Property Value

Type	Description
(number\|null)

sink

public sink?: (boolean|null);

RowFilter sink.

Property Value

Type	Description
(boolean\|null)

stripValueTransformer

public stripValueTransformer?: (boolean|null);

RowFilter stripValueTransformer.

Property Value

Type	Description
(boolean\|null)

timestampRangeFilter

public timestampRangeFilter?: (google.bigtable.v2.ITimestampRange|null);

RowFilter timestampRangeFilter.

Property Value

Type	Description
(google.bigtable.v2.ITimestampRange\|null)

valueRangeFilter

public valueRangeFilter?: (google.bigtable.v2.IValueRange|null);

RowFilter valueRangeFilter.

Property Value

Type	Description
(google.bigtable.v2.IValueRange\|null)

valueRegexFilter

public valueRegexFilter?: (Uint8Array|string|null);

RowFilter valueRegexFilter.

Property Value

Type	Description
(Uint8Array\|string\|null)

Methods

create(properties)

public static create(properties?: google.bigtable.v2.IRowFilter): google.bigtable.v2.RowFilter;

Creates a new RowFilter instance using the specified properties.

Parameter

Name	Description
properties	`IRowFilter` Properties to set

Returns

Type	Description
google.bigtable.v2.RowFilter	RowFilter instance

decode(reader, length)

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

Decodes a RowFilter 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.v2.RowFilter	RowFilter

decodeDelimited(reader)

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

Decodes a RowFilter 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.v2.RowFilter	RowFilter

encode(message, writer)

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

Encodes the specified RowFilter message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IRowFilter` RowFilter 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.v2.RowFilter;

Creates a RowFilter 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.v2.RowFilter	RowFilter

toJSON()

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

Converts this RowFilter to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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