Class protos.google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification (3.6.0)

Represents a Modification.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

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

Constructs a new Modification.

Parameter

Name	Description
properties	`IModification` Properties to set

Properties

create

public create?: (google.bigtable.admin.v2.IColumnFamily|null);

Modification create.

Property Value

Type	Description
(google.bigtable.admin.v2.IColumnFamily\|null)

drop

public drop?: (boolean|null);

Modification drop.

Property Value

Type	Description
(boolean\|null)

id

public id: string;

Modification id.

Property Value

Type	Description
string

mod

public mod?: ("create"|"update"|"drop");

Modification mod.

Property Value

Type	Description
("create"\|"update"\|"drop")

update

public update?: (google.bigtable.admin.v2.IColumnFamily|null);

Modification update.

Property Value

Type	Description
(google.bigtable.admin.v2.IColumnFamily\|null)

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.ModifyColumnFamiliesRequest.IModification): google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification;

Creates a new Modification instance using the specified properties.

Parameter

Name	Description
properties	`IModification` Properties to set

Returns

Type	Description
google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification	Modification instance

decode(reader, length)

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

Decodes a Modification 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.ModifyColumnFamiliesRequest.Modification	Modification

decodeDelimited(reader)

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

Decodes a Modification 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.ModifyColumnFamiliesRequest.Modification	Modification

encode(message, writer)

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

Encodes the specified Modification message. Does not implicitly messages.

Parameters

Name	Description
message	`IModification` Modification 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.ModifyColumnFamiliesRequest.IModification, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IModification` Modification 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.ModifyColumnFamiliesRequest.Modification;

Creates a Modification 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.ModifyColumnFamiliesRequest.Modification	Modification

toJSON()

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

Converts this Modification to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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