Represents a Table.
Package
@google-cloud/bigtableConstructors
(constructor)(properties)
constructor(properties?: google.bigtable.admin.v2.ITable);Constructs a new Table.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITable
Properties to set |
Properties
automatedBackupConfig
public automatedBackupConfig?: "automatedBackupPolicy";Table automatedBackupConfig.
automatedBackupPolicy
public automatedBackupPolicy?: (google.bigtable.admin.v2.Table.IAutomatedBackupPolicy|null);Table automatedBackupPolicy.
changeStreamConfig
public changeStreamConfig?: (google.bigtable.admin.v2.IChangeStreamConfig|null);Table changeStreamConfig.
clusterStates
public clusterStates: { [k: string]: google.bigtable.admin.v2.Table.IClusterState };Table clusterStates.
columnFamilies
public columnFamilies: { [k: string]: google.bigtable.admin.v2.IColumnFamily };Table columnFamilies.
deletionProtection
public deletionProtection: boolean;Table deletionProtection.
granularity
public granularity: (google.bigtable.admin.v2.Table.TimestampGranularity|keyof typeof google.bigtable.admin.v2.Table.TimestampGranularity);Table granularity.
name
public name: string;Table name.
restoreInfo
public restoreInfo?: (google.bigtable.admin.v2.IRestoreInfo|null);Table restoreInfo.
Methods
create(properties)
public static create(properties?: google.bigtable.admin.v2.ITable): google.bigtable.admin.v2.Table;Creates a new Table instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITable
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Table |
Table instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.bigtable.admin.v2.Table;Decodes a Table message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Table |
Table |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.bigtable.admin.v2.Table;Decodes a Table message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Table |
Table |
encode(message, writer)
public static encode(message: google.bigtable.admin.v2.ITable, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Table message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITable
Table 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.ITable, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Table message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITable
Table 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.Table;Creates a Table 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 |
Table |
Table |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Table
| 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 Table to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.bigtable.admin.v2.Table, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Table message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Table
Table |
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 Table message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|