Class protos.google.bigtable.v2.ResponseParams (5.0.0)

Represents a ResponseParams.

Package

@google-cloud/bigtable

Constructors

(constructor)(properties)

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

Constructs a new ResponseParams.

Parameter
Name Description
properties IResponseParams

Properties to set

Properties

_clusterId

public _clusterId?: "clusterId";

ResponseParams _clusterId.

_zoneId

public _zoneId?: "zoneId";

ResponseParams _zoneId.

clusterId

public clusterId?: (string|null);

ResponseParams clusterId.

zoneId

public zoneId?: (string|null);

ResponseParams zoneId.

Methods

create(properties)

public static create(properties?: google.bigtable.v2.IResponseParams): google.bigtable.v2.ResponseParams;

Creates a new ResponseParams instance using the specified properties.

Parameter
Name Description
properties IResponseParams

Properties to set

Returns
Type Description
ResponseParams

ResponseParams instance

decode(reader, length)

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

Decodes a ResponseParams 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
ResponseParams

ResponseParams

decodeDelimited(reader)

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

Decodes a ResponseParams message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ResponseParams

ResponseParams

encode(message, writer)

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

Encodes the specified ResponseParams message. Does not implicitly messages.

Parameters
Name Description
message IResponseParams

ResponseParams 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.IResponseParams, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IResponseParams

ResponseParams 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.ResponseParams;

Creates a ResponseParams 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
ResponseParams

ResponseParams

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ResponseParams

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ResponseParams

ResponseParams

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 ResponseParams 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