google-cloud-php/Bigtable/src/V2/SampleRowKeysResponse.php at 358d1072a2f8393212b2c4abc8208baebd7327ee · googleapis/google-cloud-php · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/bigtable/v2/bigtable.proto

namespace Google\Cloud\Bigtable\V2;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;

/**
 * Response message for Bigtable.SampleRowKeys.
 *
 * Generated from protobuf message <code>google.bigtable.v2.SampleRowKeysResponse</code>
 */
class SampleRowKeysResponse extends \Google\Protobuf\Internal\Message
{
    /**
     * Sorted streamed sequence of sample row keys in the table, restricted to
     * the row_range if specified in the request. The table might have contents
     * before the first row key in the list and after the last one, but a key
     * containing the empty string indicates "end of table" and will be the last
     * response given, if present and within the row-range specified in the
     * request.
     * Note that row keys in this list may not have ever been written to or read
     * from, and users should therefore not make any assumptions about the row key
     * structure that are specific to their use case.
     *
     * Generated from protobuf field <code>bytes row_key = 1;</code>
     */
    protected $row_key = '';
    /**
     * Approximate total storage space used by all rows in the table which precede
     * `row_key` (and if a row-range is specified in the request, which follow
     * what would have been the previous sample before the row-range start).
     * Buffering the contents of all rows between two subsequent
     * samples would require space roughly equal to the difference in their
     * `offset_bytes` fields.
     *
     * Generated from protobuf field <code>int64 offset_bytes = 2;</code>
     */
    protected $offset_bytes = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $row_key
     *           Sorted streamed sequence of sample row keys in the table, restricted to
     *           the row_range if specified in the request. The table might have contents
     *           before the first row key in the list and after the last one, but a key
     *           containing the empty string indicates "end of table" and will be the last
     *           response given, if present and within the row-range specified in the
     *           request.
     *           Note that row keys in this list may not have ever been written to or read
     *           from, and users should therefore not make any assumptions about the row key
     *           structure that are specific to their use case.
     *     @type int|string $offset_bytes
     *           Approximate total storage space used by all rows in the table which precede
     *           `row_key` (and if a row-range is specified in the request, which follow
     *           what would have been the previous sample before the row-range start).
     *           Buffering the contents of all rows between two subsequent
     *           samples would require space roughly equal to the difference in their
     *           `offset_bytes` fields.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Bigtable\V2\Bigtable::initOnce();
        parent::__construct($data);
    }

    /**
     * Sorted streamed sequence of sample row keys in the table, restricted to
     * the row_range if specified in the request. The table might have contents
     * before the first row key in the list and after the last one, but a key
     * containing the empty string indicates "end of table" and will be the last
     * response given, if present and within the row-range specified in the
     * request.
     * Note that row keys in this list may not have ever been written to or read
     * from, and users should therefore not make any assumptions about the row key
     * structure that are specific to their use case.
     *
     * Generated from protobuf field <code>bytes row_key = 1;</code>
     * @return string
     */
    public function getRowKey()
    {
        return $this->row_key;
    }

    /**
     * Sorted streamed sequence of sample row keys in the table, restricted to
     * the row_range if specified in the request. The table might have contents
     * before the first row key in the list and after the last one, but a key
     * containing the empty string indicates "end of table" and will be the last
     * response given, if present and within the row-range specified in the
     * request.
     * Note that row keys in this list may not have ever been written to or read
     * from, and users should therefore not make any assumptions about the row key
     * structure that are specific to their use case.
     *
     * Generated from protobuf field <code>bytes row_key = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setRowKey($var)
    {
        GPBUtil::checkString($var, False);
        $this->row_key = $var;

        return $this;
    }

    /**
     * Approximate total storage space used by all rows in the table which precede
     * `row_key` (and if a row-range is specified in the request, which follow
     * what would have been the previous sample before the row-range start).
     * Buffering the contents of all rows between two subsequent
     * samples would require space roughly equal to the difference in their
     * `offset_bytes` fields.
     *
     * Generated from protobuf field <code>int64 offset_bytes = 2;</code>
     * @return int|string
     */
    public function getOffsetBytes()
    {
        return $this->offset_bytes;
    }

    /**
     * Approximate total storage space used by all rows in the table which precede
     * `row_key` (and if a row-range is specified in the request, which follow
     * what would have been the previous sample before the row-range start).
     * Buffering the contents of all rows between two subsequent
     * samples would require space roughly equal to the difference in their
     * `offset_bytes` fields.
     *
     * Generated from protobuf field <code>int64 offset_bytes = 2;</code>
     * @param int|string $var
     * @return $this
     */
    public function setOffsetBytes($var)
    {
        GPBUtil::checkInt64($var);
        $this->offset_bytes = $var;

        return $this;
    }

}