Class protos.google.bigtable.admin.v2.AppProfile (3.6.0)

Represents an AppProfile.

Package

@google-cloud/bigtable!

Constructors

(constructor)(properties)

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

Constructs a new AppProfile.

Parameter

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

Properties

description

public description: string;

AppProfile description.

Property Value

Type	Description
string

etag

public etag: string;

AppProfile etag.

Property Value

Type	Description
string

multiClusterRoutingUseAny

public multiClusterRoutingUseAny?: (google.bigtable.admin.v2.AppProfile.IMultiClusterRoutingUseAny|null);

AppProfile multiClusterRoutingUseAny.

Property Value

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

name

public name: string;

AppProfile name.

Property Value

Type	Description
string

routingPolicy

public routingPolicy?: ("multiClusterRoutingUseAny"|"singleClusterRouting");

AppProfile routingPolicy.

Property Value

Type	Description
("multiClusterRoutingUseAny"\|"singleClusterRouting")

singleClusterRouting

public singleClusterRouting?: (google.bigtable.admin.v2.AppProfile.ISingleClusterRouting|null);

AppProfile singleClusterRouting.

Property Value

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

Methods

create(properties)

public static create(properties?: google.bigtable.admin.v2.IAppProfile): google.bigtable.admin.v2.AppProfile;

Creates a new AppProfile instance using the specified properties.

Parameter

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

Returns

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

decode(reader, length)

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

Decodes an AppProfile 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.AppProfile	AppProfile

decodeDelimited(reader)

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

Decodes an AppProfile 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.AppProfile	AppProfile

encode(message, writer)

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

Encodes the specified AppProfile message. Does not implicitly messages.

Parameters

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

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

Parameters

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

Creates an AppProfile 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.AppProfile	AppProfile

toJSON()

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

Converts this AppProfile to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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