ReadRowsRequest

google.bigtable.v2. ReadRowsRequest

Represents a ReadRowsRequest.

Constructor

new ReadRowsRequest(propertiesopt)

Constructs a new ReadRowsRequest.

Parameters:
Name Type Attributes Description
properties google.bigtable.v2.IReadRowsRequest <optional>

Properties to set

Implements:
  • IReadRowsRequest

Members

appProfileId

ReadRowsRequest appProfileId.

authorizedViewName

ReadRowsRequest authorizedViewName.

filter

ReadRowsRequest filter.

materializedViewName

ReadRowsRequest materializedViewName.

requestStatsView

ReadRowsRequest requestStatsView.

reversed

ReadRowsRequest reversed.

rows

ReadRowsRequest rows.

rowsLimit

ReadRowsRequest rowsLimit.

tableName

ReadRowsRequest tableName.

RequestStatsView

RequestStatsView enum.

Properties:
Name Type Description
REQUEST_STATS_VIEW_UNSPECIFIED number

REQUEST_STATS_VIEW_UNSPECIFIED value

REQUEST_STATS_NONE number

REQUEST_STATS_NONE value

REQUEST_STATS_FULL number

REQUEST_STATS_FULL value

Methods

toJSON() → {Object.<string, *>}

Converts this ReadRowsRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.bigtable.v2.ReadRowsRequest}

Creates a new ReadRowsRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.bigtable.v2.IReadRowsRequest <optional>

Properties to set

Returns:
Type Description
google.bigtable.v2.ReadRowsRequest

ReadRowsRequest instance

(static) decode(reader, lengthopt) → {google.bigtable.v2.ReadRowsRequest}

Decodes a ReadRowsRequest message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.bigtable.v2.ReadRowsRequest

ReadRowsRequest

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.bigtable.v2.ReadRowsRequest}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.bigtable.v2.ReadRowsRequest

ReadRowsRequest

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified ReadRowsRequest message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.bigtable.v2.IReadRowsRequest

ReadRowsRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.bigtable.v2.IReadRowsRequest

ReadRowsRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.bigtable.v2.ReadRowsRequest}

Creates a ReadRowsRequest message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.bigtable.v2.ReadRowsRequest

ReadRowsRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ReadRowsRequest

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.bigtable.v2.ReadRowsRequest

ReadRowsRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a ReadRowsRequest message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not