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. If not specified, the "default" application profile will be used.

Returns:

  • (::String) —

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 70

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

#authorized_view_name ⇒ ::String

Returns 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>.

Returns:

  • (::String) —

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 70

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:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 70

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:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 70

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

#reversed ⇒ ::Boolean

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"}
]

Returns:

  • (::Boolean) —

    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"}
]



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 70

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:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 70

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.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 70

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 Optional. The unique name of the table from which to read.

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

Returns:

  • (::String) —

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

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 70

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