Class: Google::Cloud::Bigtable::V2::ReadRowsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/v2/bigtable.rb

Overview

Request message for Bigtable.ReadRows.

Defined Under Namespace

Modules: RequestStatsView

Instance Attribute Summary collapse

Instance Attribute Details

#app_profile_id ⇒ ::String

Returns This value specifies routing for replication. This API only accepts the empty value of app_profile_id.

Returns:

  • (::String) —

    This value specifies routing for replication. This API only accepts the empty value of app_profile_id.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 49

class ReadRowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The desired view into RequestStats that should be returned in the response.
  #
  # See also: RequestStats message.
  module RequestStatsView
    # The default / unset value. The API will default to the NONE option below.
    REQUEST_STATS_VIEW_UNSPECIFIED = 0

    # Do not include any RequestStats in the response. This will leave the
    # RequestStats embedded message unset in the response.
    REQUEST_STATS_NONE = 1

    # Include the full set of available RequestStats in the response,
    # applicable to this read.
    REQUEST_STATS_FULL = 2
  end
end

#filter ⇒ ::Google::Cloud::Bigtable::V2::RowFilter

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

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 49

class ReadRowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The desired view into RequestStats that should be returned in the response.
  #
  # See also: RequestStats message.
  module RequestStatsView
    # The default / unset value. The API will default to the NONE option below.
    REQUEST_STATS_VIEW_UNSPECIFIED = 0

    # Do not include any RequestStats in the response. This will leave the
    # RequestStats embedded message unset in the response.
    REQUEST_STATS_NONE = 1

    # Include the full set of available RequestStats in the response,
    # applicable to this read.
    REQUEST_STATS_FULL = 2
  end
end

#request_stats_view ⇒ ::Google::Cloud::Bigtable::V2::ReadRowsRequest::RequestStatsView

Returns The view into RequestStats, as described above.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 49

class ReadRowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The desired view into RequestStats that should be returned in the response.
  #
  # See also: RequestStats message.
  module RequestStatsView
    # The default / unset value. The API will default to the NONE option below.
    REQUEST_STATS_VIEW_UNSPECIFIED = 0

    # Do not include any RequestStats in the response. This will leave the
    # RequestStats embedded message unset in the response.
    REQUEST_STATS_NONE = 1

    # Include the full set of available RequestStats in the response,
    # applicable to this read.
    REQUEST_STATS_FULL = 2
  end
end

#rows ⇒ ::Google::Cloud::Bigtable::V2::RowSet

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

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 49

class ReadRowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The desired view into RequestStats that should be returned in the response.
  #
  # See also: RequestStats message.
  module RequestStatsView
    # The default / unset value. The API will default to the NONE option below.
    REQUEST_STATS_VIEW_UNSPECIFIED = 0

    # Do not include any RequestStats in the response. This will leave the
    # RequestStats embedded message unset in the response.
    REQUEST_STATS_NONE = 1

    # Include the full set of available RequestStats in the response,
    # applicable to this read.
    REQUEST_STATS_FULL = 2
  end
end

#rows_limit ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 49

class ReadRowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The desired view into RequestStats that should be returned in the response.
  #
  # See also: RequestStats message.
  module RequestStatsView
    # The default / unset value. The API will default to the NONE option below.
    REQUEST_STATS_VIEW_UNSPECIFIED = 0

    # Do not include any RequestStats in the response. This will leave the
    # RequestStats embedded message unset in the response.
    REQUEST_STATS_NONE = 1

    # Include the full set of available RequestStats in the response,
    # applicable to this read.
    REQUEST_STATS_FULL = 2
  end
end

#table_name ⇒ ::String

Returns Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Returns:

  • (::String) —

    Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 49

class ReadRowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The desired view into RequestStats that should be returned in the response.
  #
  # See also: RequestStats message.
  module RequestStatsView
    # The default / unset value. The API will default to the NONE option below.
    REQUEST_STATS_VIEW_UNSPECIFIED = 0

    # Do not include any RequestStats in the response. This will leave the
    # RequestStats embedded message unset in the response.
    REQUEST_STATS_NONE = 1

    # Include the full set of available RequestStats in the response,
    # applicable to this read.
    REQUEST_STATS_FULL = 2
  end
end