Class protos.google.bigtable.v2.SessionRequest (0.11.1)

Represents a SessionRequest.

Implements

Package

@google-cloud/bigtable-api

Constructors

(constructor)(properties)

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

Constructs a new SessionRequest.

Parameter
Name Description
properties ISessionRequest

Properties to set

Properties

cancelVirtualRpc

public cancelVirtualRpc?: (google.bigtable.v2.ICancelVirtualRpcRequest|null);

SessionRequest cancelVirtualRpc.

closeSession

public closeSession?: (google.bigtable.v2.ICloseSessionRequest|null);

SessionRequest closeSession.

continueVirtualRpc

public continueVirtualRpc?: (google.bigtable.v2.IContinueVirtualRpcRequest|null);

SessionRequest continueVirtualRpc.

openSession

public openSession?: (google.bigtable.v2.IOpenSessionRequest|null);

SessionRequest openSession.

payload

public payload?: ("openSession"|"closeSession"|"virtualRpc"|"continueVirtualRpc"|"cancelVirtualRpc");

SessionRequest payload.

virtualRpc

public virtualRpc?: (google.bigtable.v2.IVirtualRpcRequest|null);

SessionRequest virtualRpc.

Methods

create(properties)

public static create(properties?: google.bigtable.v2.ISessionRequest): google.bigtable.v2.SessionRequest;

Creates a new SessionRequest instance using the specified properties.

Parameter
Name Description
properties ISessionRequest

Properties to set

Returns
Type Description
SessionRequest

SessionRequest instance

decode(reader, length)

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

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

SessionRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SessionRequest

SessionRequest

encode(message, writer)

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

Encodes the specified SessionRequest message. Does not implicitly messages.

Parameters
Name Description
message ISessionRequest

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

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

Parameters
Name Description
message ISessionRequest

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

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

SessionRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SessionRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SessionRequest

SessionRequest

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