google-cloud-bigquery-storage-v1 0.1.1 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -25,7 +25,7 @@ module Google
25
25
  module V1
26
26
  module BigQueryRead
27
27
  # Credentials for the BigQueryRead API.
28
- class Credentials < Google::Auth::Credentials
28
+ class Credentials < ::Google::Auth::Credentials
29
29
  self.scope = [
30
30
  "https://www.googleapis.com/auth/bigquery",
31
31
  "https://www.googleapis.com/auth/bigquery.readonly",
@@ -34,7 +34,7 @@ module Google
34
34
  #
35
35
  # @param project [String]
36
36
  #
37
- # @return [String]
37
+ # @return [::String]
38
38
  def project_path project:
39
39
  "projects/#{project}"
40
40
  end
@@ -50,10 +50,10 @@ module Google
50
50
  # @param location [String]
51
51
  # @param session [String]
52
52
  #
53
- # @return [String]
53
+ # @return [::String]
54
54
  def read_session_path project:, location:, session:
55
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
56
- raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
55
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
56
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
57
57
 
58
58
  "projects/#{project}/locations/#{location}/sessions/#{session}"
59
59
  end
@@ -70,11 +70,11 @@ module Google
70
70
  # @param session [String]
71
71
  # @param stream [String]
72
72
  #
73
- # @return [String]
73
+ # @return [::String]
74
74
  def read_stream_path project:, location:, session:, stream:
75
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
76
- raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
77
- raise ArgumentError, "session cannot contain /" if session.to_s.include? "/"
75
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
76
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
77
+ raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
78
78
 
79
79
  "projects/#{project}/locations/#{location}/sessions/#{session}/streams/#{stream}"
80
80
  end
@@ -90,10 +90,10 @@ module Google
90
90
  # @param dataset [String]
91
91
  # @param table [String]
92
92
  #
93
- # @return [String]
93
+ # @return [::String]
94
94
  def table_path project:, dataset:, table:
95
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
96
- raise ArgumentError, "dataset cannot contain /" if dataset.to_s.include? "/"
95
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
96
+ raise ::ArgumentError, "dataset cannot contain /" if dataset.to_s.include? "/"
97
97
 
98
98
  "projects/#{project}/datasets/#{dataset}/tables/#{table}"
99
99
  end
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigquery
23
23
  module Storage
24
24
  module V1
25
- VERSION = "0.1.1"
25
+ VERSION = "0.2.1"
26
26
  end
27
27
  end
28
28
  end
@@ -128,7 +128,7 @@ module Google
128
128
  # - pattern: "shelves/{shelf}"
129
129
  # parent_type: "cloudresourcemanager.googleapis.com/Folder"
130
130
  # @!attribute [rw] type
131
- # @return [String]
131
+ # @return [::String]
132
132
  # The resource type. It must be in the format of
133
133
  # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134
134
  # singular and must not include version numbers.
@@ -140,7 +140,7 @@ module Google
140
140
  # should use PascalCase (UpperCamelCase). The maximum number of
141
141
  # characters allowed for the `resource_type_kind` is 100.
142
142
  # @!attribute [rw] pattern
143
- # @return [Array<String>]
143
+ # @return [::Array<::String>]
144
144
  # Optional. The relative resource name pattern associated with this resource
145
145
  # type. The DNS prefix of the full resource name shouldn't be specified here.
146
146
  #
@@ -161,11 +161,11 @@ module Google
161
161
  # the same component name (e.g. "project") refers to IDs of the same
162
162
  # type of resource.
163
163
  # @!attribute [rw] name_field
164
- # @return [String]
164
+ # @return [::String]
165
165
  # Optional. The field on the resource that designates the resource name
166
166
  # field. If omitted, this is assumed to be "name".
167
167
  # @!attribute [rw] history
168
- # @return [Google::Api::ResourceDescriptor::History]
168
+ # @return [::Google::Api::ResourceDescriptor::History]
169
169
  # Optional. The historical or future-looking state of the resource pattern.
170
170
  #
171
171
  # Example:
@@ -182,19 +182,19 @@ module Google
182
182
  # };
183
183
  # }
184
184
  # @!attribute [rw] plural
185
- # @return [String]
185
+ # @return [::String]
186
186
  # The plural name used in the resource name, such as 'projects' for
187
187
  # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
188
  # field in k8s CRD spec
189
189
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
190
190
  # @!attribute [rw] singular
191
- # @return [String]
191
+ # @return [::String]
192
192
  # The same concept of the `singular` field in k8s CRD spec
193
193
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
194
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
195
195
  class ResourceDescriptor
196
- include Google::Protobuf::MessageExts
197
- extend Google::Protobuf::MessageExts::ClassMethods
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
198
 
199
199
  # A description of the historical or future-looking state of the
200
200
  # resource pattern.
@@ -216,7 +216,7 @@ module Google
216
216
  # Defines a proto annotation that describes a string field that refers to
217
217
  # an API resource.
218
218
  # @!attribute [rw] type
219
- # @return [String]
219
+ # @return [::String]
220
220
  # The resource type that the annotated field references.
221
221
  #
222
222
  # Example:
@@ -227,7 +227,7 @@ module Google
227
227
  # }];
228
228
  # }
229
229
  # @!attribute [rw] child_type
230
- # @return [String]
230
+ # @return [::String]
231
231
  # The resource type of a child collection that the annotated field
232
232
  # references. This is useful for annotating the `parent` field that
233
233
  # doesn't have a fixed resource type.
@@ -240,8 +240,8 @@ module Google
240
240
  # };
241
241
  # }
242
242
  class ResourceReference
243
- include Google::Protobuf::MessageExts
244
- extend Google::Protobuf::MessageExts::ClassMethods
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
245
  end
246
246
  end
247
247
  end
@@ -25,27 +25,27 @@ module Google
25
25
  # Arrow schema as specified in
26
26
  # https://arrow.apache.org/docs/python/api/datatypes.html
27
27
  # and serialized to bytes using IPC:
28
- # https://arrow.apache.org/docs/ipc.html.
28
+ # https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc
29
29
  #
30
30
  # See code samples on how this message can be deserialized.
31
31
  # @!attribute [rw] serialized_schema
32
- # @return [String]
32
+ # @return [::String]
33
33
  # IPC serialized Arrow schema.
34
34
  class ArrowSchema
35
- include Google::Protobuf::MessageExts
36
- extend Google::Protobuf::MessageExts::ClassMethods
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
37
  end
38
38
 
39
39
  # Arrow RecordBatch.
40
40
  # @!attribute [rw] serialized_record_batch
41
- # @return [String]
41
+ # @return [::String]
42
42
  # IPC-serialized Arrow RecordBatch.
43
43
  # @!attribute [rw] row_count
44
- # @return [Integer]
44
+ # @return [::Integer]
45
45
  # The count of rows in `serialized_record_batch`.
46
46
  class ArrowRecordBatch
47
- include Google::Protobuf::MessageExts
48
- extend Google::Protobuf::MessageExts::ClassMethods
47
+ include ::Google::Protobuf::MessageExts
48
+ extend ::Google::Protobuf::MessageExts::ClassMethods
49
49
  end
50
50
  end
51
51
  end
@@ -24,24 +24,24 @@ module Google
24
24
  module V1
25
25
  # Avro schema.
26
26
  # @!attribute [rw] schema
27
- # @return [String]
27
+ # @return [::String]
28
28
  # Json serialized schema, as described at
29
29
  # https://avro.apache.org/docs/1.8.1/spec.html.
30
30
  class AvroSchema
31
- include Google::Protobuf::MessageExts
32
- extend Google::Protobuf::MessageExts::ClassMethods
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
33
  end
34
34
 
35
35
  # Avro rows.
36
36
  # @!attribute [rw] serialized_binary_rows
37
- # @return [String]
37
+ # @return [::String]
38
38
  # Binary serialized rows in a block.
39
39
  # @!attribute [rw] row_count
40
- # @return [Integer]
40
+ # @return [::Integer]
41
41
  # The count of rows in the returning block.
42
42
  class AvroRows
43
- include Google::Protobuf::MessageExts
44
- extend Google::Protobuf::MessageExts::ClassMethods
43
+ include ::Google::Protobuf::MessageExts
44
+ extend ::Google::Protobuf::MessageExts::ClassMethods
45
45
  end
46
46
  end
47
47
  end
@@ -24,14 +24,14 @@ module Google
24
24
  module V1
25
25
  # Request message for `CreateReadSession`.
26
26
  # @!attribute [rw] parent
27
- # @return [String]
27
+ # @return [::String]
28
28
  # Required. The request project that owns the session, in the form of
29
29
  # `projects/{project_id}`.
30
30
  # @!attribute [rw] read_session
31
- # @return [Google::Cloud::Bigquery::Storage::V1::ReadSession]
31
+ # @return [::Google::Cloud::Bigquery::Storage::V1::ReadSession]
32
32
  # Required. Session to be created.
33
33
  # @!attribute [rw] max_stream_count
34
- # @return [Integer]
34
+ # @return [::Integer]
35
35
  # Max initial number of streams. If unset or zero, the server will
36
36
  # provide a value of streams so as to produce reasonable throughput. Must be
37
37
  # non-negative. The number of streams may be lower than the requested number,
@@ -41,44 +41,44 @@ module Google
41
41
  #
42
42
  # Streams must be read starting from offset 0.
43
43
  class CreateReadSessionRequest
44
- include Google::Protobuf::MessageExts
45
- extend Google::Protobuf::MessageExts::ClassMethods
44
+ include ::Google::Protobuf::MessageExts
45
+ extend ::Google::Protobuf::MessageExts::ClassMethods
46
46
  end
47
47
 
48
48
  # Request message for `ReadRows`.
49
49
  # @!attribute [rw] read_stream
50
- # @return [String]
50
+ # @return [::String]
51
51
  # Required. Stream to read rows from.
52
52
  # @!attribute [rw] offset
53
- # @return [Integer]
53
+ # @return [::Integer]
54
54
  # The offset requested must be less than the last row read from Read.
55
55
  # Requesting a larger offset is undefined. If not specified, start reading
56
56
  # from offset zero.
57
57
  class ReadRowsRequest
58
- include Google::Protobuf::MessageExts
59
- extend Google::Protobuf::MessageExts::ClassMethods
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
60
  end
61
61
 
62
62
  # Information on if the current connection is being throttled.
63
63
  # @!attribute [rw] throttle_percent
64
- # @return [Integer]
64
+ # @return [::Integer]
65
65
  # How much this connection is being throttled. Zero means no throttling,
66
66
  # 100 means fully throttled.
67
67
  class ThrottleState
68
- include Google::Protobuf::MessageExts
69
- extend Google::Protobuf::MessageExts::ClassMethods
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
70
  end
71
71
 
72
72
  # Estimated stream statistics for a given Stream.
73
73
  # @!attribute [rw] progress
74
- # @return [Google::Cloud::Bigquery::Storage::V1::StreamStats::Progress]
74
+ # @return [::Google::Cloud::Bigquery::Storage::V1::StreamStats::Progress]
75
75
  # Represents the progress of the current stream.
76
76
  class StreamStats
77
- include Google::Protobuf::MessageExts
78
- extend Google::Protobuf::MessageExts::ClassMethods
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
79
 
80
80
  # @!attribute [rw] at_response_start
81
- # @return [Float]
81
+ # @return [::Float]
82
82
  # The fraction of rows assigned to the stream that have been processed by
83
83
  # the server so far, not including the rows in the current response
84
84
  # message.
@@ -92,44 +92,44 @@ module Google
92
92
  # previous response may not necessarily be equal to the
93
93
  # `at_response_start` value of the current response.
94
94
  # @!attribute [rw] at_response_end
95
- # @return [Float]
95
+ # @return [::Float]
96
96
  # Similar to `at_response_start`, except that this value includes the
97
97
  # rows in the current response.
98
98
  class Progress
99
- include Google::Protobuf::MessageExts
100
- extend Google::Protobuf::MessageExts::ClassMethods
99
+ include ::Google::Protobuf::MessageExts
100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
101
101
  end
102
102
  end
103
103
 
104
104
  # Response from calling `ReadRows` may include row data, progress and
105
105
  # throttling information.
106
106
  # @!attribute [rw] avro_rows
107
- # @return [Google::Cloud::Bigquery::Storage::V1::AvroRows]
107
+ # @return [::Google::Cloud::Bigquery::Storage::V1::AvroRows]
108
108
  # Serialized row data in AVRO format.
109
109
  # @!attribute [rw] arrow_record_batch
110
- # @return [Google::Cloud::Bigquery::Storage::V1::ArrowRecordBatch]
110
+ # @return [::Google::Cloud::Bigquery::Storage::V1::ArrowRecordBatch]
111
111
  # Serialized row data in Arrow RecordBatch format.
112
112
  # @!attribute [rw] row_count
113
- # @return [Integer]
113
+ # @return [::Integer]
114
114
  # Number of serialized rows in the rows block.
115
115
  # @!attribute [rw] stats
116
- # @return [Google::Cloud::Bigquery::Storage::V1::StreamStats]
116
+ # @return [::Google::Cloud::Bigquery::Storage::V1::StreamStats]
117
117
  # Statistics for the stream.
118
118
  # @!attribute [rw] throttle_state
119
- # @return [Google::Cloud::Bigquery::Storage::V1::ThrottleState]
119
+ # @return [::Google::Cloud::Bigquery::Storage::V1::ThrottleState]
120
120
  # Throttling state. If unset, the latest response still describes
121
121
  # the current throttling status.
122
122
  class ReadRowsResponse
123
- include Google::Protobuf::MessageExts
124
- extend Google::Protobuf::MessageExts::ClassMethods
123
+ include ::Google::Protobuf::MessageExts
124
+ extend ::Google::Protobuf::MessageExts::ClassMethods
125
125
  end
126
126
 
127
127
  # Request message for `SplitReadStream`.
128
128
  # @!attribute [rw] name
129
- # @return [String]
129
+ # @return [::String]
130
130
  # Required. Name of the stream to split.
131
131
  # @!attribute [rw] fraction
132
- # @return [Float]
132
+ # @return [::Float]
133
133
  # A value in the range (0.0, 1.0) that specifies the fractional point at
134
134
  # which the original stream should be split. The actual split point is
135
135
  # evaluated on pre-filtered rows, so if a filter is provided, then there is
@@ -138,23 +138,23 @@ module Google
138
138
  # server-side unit for assigning data is collections of rows, this fraction
139
139
  # will always map to a data storage boundary on the server side.
140
140
  class SplitReadStreamRequest
141
- include Google::Protobuf::MessageExts
142
- extend Google::Protobuf::MessageExts::ClassMethods
141
+ include ::Google::Protobuf::MessageExts
142
+ extend ::Google::Protobuf::MessageExts::ClassMethods
143
143
  end
144
144
 
145
145
  # Response message for `SplitReadStream`.
146
146
  # @!attribute [rw] primary_stream
147
- # @return [Google::Cloud::Bigquery::Storage::V1::ReadStream]
147
+ # @return [::Google::Cloud::Bigquery::Storage::V1::ReadStream]
148
148
  # Primary stream, which contains the beginning portion of
149
149
  # |original_stream|. An empty value indicates that the original stream can no
150
150
  # longer be split.
151
151
  # @!attribute [rw] remainder_stream
152
- # @return [Google::Cloud::Bigquery::Storage::V1::ReadStream]
152
+ # @return [::Google::Cloud::Bigquery::Storage::V1::ReadStream]
153
153
  # Remainder stream, which contains the tail of |original_stream|. An empty
154
154
  # value indicates that the original stream can no longer be split.
155
155
  class SplitReadStreamResponse
156
- include Google::Protobuf::MessageExts
157
- extend Google::Protobuf::MessageExts::ClassMethods
156
+ include ::Google::Protobuf::MessageExts
157
+ extend ::Google::Protobuf::MessageExts::ClassMethods
158
158
  end
159
159
  end
160
160
  end
@@ -24,35 +24,35 @@ module Google
24
24
  module V1
25
25
  # Information about the ReadSession.
26
26
  # @!attribute [r] name
27
- # @return [String]
27
+ # @return [::String]
28
28
  # Output only. Unique identifier for the session, in the form
29
29
  # `projects/{project_id}/locations/{location}/sessions/{session_id}`.
30
30
  # @!attribute [r] expire_time
31
- # @return [Google::Protobuf::Timestamp]
31
+ # @return [::Google::Protobuf::Timestamp]
32
32
  # Output only. Time at which the session becomes invalid. After this time, subsequent
33
33
  # requests to read this Session will return errors. The expire_time is
34
34
  # automatically assigned and currently cannot be specified or updated.
35
35
  # @!attribute [rw] data_format
36
- # @return [Google::Cloud::Bigquery::Storage::V1::DataFormat]
36
+ # @return [::Google::Cloud::Bigquery::Storage::V1::DataFormat]
37
37
  # Immutable. Data format of the output data.
38
38
  # @!attribute [r] avro_schema
39
- # @return [Google::Cloud::Bigquery::Storage::V1::AvroSchema]
39
+ # @return [::Google::Cloud::Bigquery::Storage::V1::AvroSchema]
40
40
  # Output only. Avro schema.
41
41
  # @!attribute [r] arrow_schema
42
- # @return [Google::Cloud::Bigquery::Storage::V1::ArrowSchema]
42
+ # @return [::Google::Cloud::Bigquery::Storage::V1::ArrowSchema]
43
43
  # Output only. Arrow schema.
44
44
  # @!attribute [rw] table
45
- # @return [String]
45
+ # @return [::String]
46
46
  # Immutable. Table that this ReadSession is reading from, in the form
47
47
  # `projects/{project_id}/datasets/{dataset_id}/tables/{table_id}`
48
48
  # @!attribute [rw] table_modifiers
49
- # @return [Google::Cloud::Bigquery::Storage::V1::ReadSession::TableModifiers]
49
+ # @return [::Google::Cloud::Bigquery::Storage::V1::ReadSession::TableModifiers]
50
50
  # Optional. Any modifiers which are applied when reading from the specified table.
51
51
  # @!attribute [rw] read_options
52
- # @return [Google::Cloud::Bigquery::Storage::V1::ReadSession::TableReadOptions]
52
+ # @return [::Google::Cloud::Bigquery::Storage::V1::ReadSession::TableReadOptions]
53
53
  # Optional. Read options for this session (e.g. column selection, filters).
54
54
  # @!attribute [r] streams
55
- # @return [Array<Google::Cloud::Bigquery::Storage::V1::ReadStream>]
55
+ # @return [::Array<::Google::Cloud::Bigquery::Storage::V1::ReadStream>]
56
56
  # Output only. A list of streams created with the session.
57
57
  #
58
58
  # At least one stream is created with the session. In the future, larger
@@ -60,27 +60,27 @@ module Google
60
60
  # in that case, the user will need to use a List method to get the streams
61
61
  # instead, which is not yet available.
62
62
  class ReadSession
63
- include Google::Protobuf::MessageExts
64
- extend Google::Protobuf::MessageExts::ClassMethods
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
65
 
66
66
  # Additional attributes when reading a table.
67
67
  # @!attribute [rw] snapshot_time
68
- # @return [Google::Protobuf::Timestamp]
68
+ # @return [::Google::Protobuf::Timestamp]
69
69
  # The snapshot time of the table. If not set, interpreted as now.
70
70
  class TableModifiers
71
- include Google::Protobuf::MessageExts
72
- extend Google::Protobuf::MessageExts::ClassMethods
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
73
  end
74
74
 
75
75
  # Options dictating how we read a table.
76
76
  # @!attribute [rw] selected_fields
77
- # @return [Array<String>]
77
+ # @return [::Array<::String>]
78
78
  # Names of the fields in the table that should be read. If empty, all
79
79
  # fields will be read. If the specified field is a nested field, all
80
80
  # the sub-fields in the field will be selected. The output field order is
81
81
  # unrelated to the order of fields in selected_fields.
82
82
  # @!attribute [rw] row_restriction
83
- # @return [String]
83
+ # @return [::String]
84
84
  # SQL text filtering statement, similar to a WHERE clause in a query.
85
85
  # Aggregates are not supported.
86
86
  #
@@ -90,8 +90,8 @@ module Google
90
90
  # "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
91
91
  # "numeric_field BETWEEN 1.0 AND 5.0"
92
92
  class TableReadOptions
93
- include Google::Protobuf::MessageExts
94
- extend Google::Protobuf::MessageExts::ClassMethods
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
95
  end
96
96
  end
97
97
 
@@ -99,12 +99,12 @@ module Google
99
99
  # Most of the information about `ReadStream` instances is aggregated, making
100
100
  # `ReadStream` lightweight.
101
101
  # @!attribute [r] name
102
- # @return [String]
102
+ # @return [::String]
103
103
  # Output only. Name of the stream, in the form
104
104
  # `projects/{project_id}/locations/{location}/sessions/{session_id}/streams/{stream_id}`.
105
105
  class ReadStream
106
- include Google::Protobuf::MessageExts
107
- extend Google::Protobuf::MessageExts::ClassMethods
106
+ include ::Google::Protobuf::MessageExts
107
+ extend ::Google::Protobuf::MessageExts::ClassMethods
108
108
  end
109
109
 
110
110
  # Data format for input or output data.