Google Bigtable v2 API - Class ReadRowsRequest (3.10.0)

public sealed class ReadRowsRequest : IMessage<ReadRowsRequest>, IEquatable<ReadRowsRequest>, IDeepCloneable<ReadRowsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Bigtable v2 API class ReadRowsRequest.

Request message for Bigtable.ReadRows.

Inheritance

object > ReadRowsRequest

Implements

IMessage ReadRowsRequest, IEquatable ReadRowsRequest, IDeepCloneable ReadRowsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

ReadRowsRequest()

public ReadRowsRequest()

ReadRowsRequest(ReadRowsRequest)

public ReadRowsRequest(ReadRowsRequest other)

Parameter
Name	Description
`other`	`ReadRowsRequest`

Properties

AppProfileId

public string AppProfileId { get; set; }

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Property Value
Type	Description
`string`

AuthorizedViewName

public string AuthorizedViewName { get; set; }

Optional. The unique name of the AuthorizedView from which to read.

Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.

Property Value
Type	Description
`string`

AuthorizedViewNameAsAuthorizedViewName

public AuthorizedViewName AuthorizedViewNameAsAuthorizedViewName { get; set; }

AuthorizedViewName-typed view over the AuthorizedViewName resource name property.

Property Value
Type	Description
`AuthorizedViewName`

Filter

public RowFilter Filter { get; set; }

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

Property Value
Type	Description
`RowFilter`

RequestStatsView

public ReadRowsRequest.Types.RequestStatsView RequestStatsView { get; set; }

The view into RequestStats, as described above.

Property Value
Type	Description
`ReadRowsRequestTypesRequestStatsView`

Reversed

public bool Reversed { get; set; }

Experimental API - Please note that this API is currently experimental and can change in the future.

Return rows in lexiographical descending order of the row keys. The row contents will not be affected by this flag.

Example result set:

[
  {key: "k2", "f:col1": "v1", "f:col2": "v1"},
  {key: "k1", "f:col1": "v2", "f:col2": "v2"}
]

Property Value
Type	Description
`bool`

Rows

public RowSet Rows { get; set; }

The row keys and/or ranges to read sequentially. If not specified, reads from all rows.

Property Value
Type	Description
`RowSet`

RowsLimit

public long RowsLimit { get; set; }

The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.

Property Value
Type	Description
`long`

TableName

public string TableName { get; set; }

Optional. The unique name of the table from which to read.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Property Value
Type	Description
`string`

TableNameAsTableName

public TableName TableNameAsTableName { get; set; }

TableName-typed view over the TableName resource name property.

Property Value
Type	Description
`TableName`