@google-cloud/bigquery-storage-api 0.3.0 → 0.4.0
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.
- package/build/protos/google/cloud/bigquery/storage/v1/arrow.proto +1 -1
- package/build/protos/google/cloud/bigquery/storage/v1/avro.proto +1 -1
- package/build/protos/google/cloud/bigquery/storage/v1/protobuf.proto +1 -1
- package/build/protos/google/cloud/bigquery/storage/v1/storage.proto +89 -2
- package/build/protos/google/cloud/bigquery/storage/v1/stream.proto +1 -1
- package/build/protos/google/cloud/bigquery/storage/v1/table.proto +1 -1
- package/build/protos/protos.d.ts +369 -0
- package/build/protos/protos.js +1 -1
- package/build/protos/protos.json +1 -1
- package/build/src/v1/big_query_read_client.d.ts +4 -0
- package/build/src/v1/big_query_read_client.js +4 -0
- package/build/src/v1/big_query_read_client.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Copyright
|
|
1
|
+
// Copyright 2026 Google LLC
|
|
2
2
|
//
|
|
3
3
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
// you may not use this file except in compliance with the License.
|
|
@@ -279,6 +279,18 @@ message ReadRowsRequest {
|
|
|
279
279
|
// Requesting a larger offset is undefined. If not specified, start reading
|
|
280
280
|
// from offset zero.
|
|
281
281
|
int64 offset = 2;
|
|
282
|
+
|
|
283
|
+
// Specifies output serialization options. Only job _default streams are
|
|
284
|
+
// supported.
|
|
285
|
+
//
|
|
286
|
+
// This feature is not yet available.
|
|
287
|
+
oneof output_format_serialization_options {
|
|
288
|
+
// Optional. Options specific to the Apache Arrow output format.
|
|
289
|
+
//
|
|
290
|
+
// This feature is not yet available.
|
|
291
|
+
ArrowSerializationOptions arrow_serialization_options = 5
|
|
292
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
293
|
+
}
|
|
282
294
|
}
|
|
283
295
|
|
|
284
296
|
// Information on if the current connection is being throttled.
|
|
@@ -365,6 +377,13 @@ message ReadRowsResponse {
|
|
|
365
377
|
// greater than 0, the client should skip decompression.
|
|
366
378
|
optional int64 uncompressed_byte_size = 9
|
|
367
379
|
[(google.api.field_behavior) = OPTIONAL];
|
|
380
|
+
|
|
381
|
+
// Output only. The total estimated number of rows in the query results.
|
|
382
|
+
// Only populated when reading data from a BigQuery job.
|
|
383
|
+
//
|
|
384
|
+
// This feature is not yet available.
|
|
385
|
+
optional int64 total_estimated_row_count = 10
|
|
386
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
368
387
|
}
|
|
369
388
|
|
|
370
389
|
// Request message for `SplitReadStream`.
|
|
@@ -419,7 +438,7 @@ message CreateWriteStreamRequest {
|
|
|
419
438
|
// switching table destinations. You can also switch table destinations within
|
|
420
439
|
// the same connection for the default stream.
|
|
421
440
|
//
|
|
422
|
-
// The size of a single AppendRowsRequest must be less than
|
|
441
|
+
// The size of a single AppendRowsRequest must be less than 20 MB in size.
|
|
423
442
|
// Requests larger than this return an error, typically `INVALID_ARGUMENT`.
|
|
424
443
|
message AppendRowsRequest {
|
|
425
444
|
// Arrow schema and data.
|
|
@@ -559,6 +578,9 @@ message AppendRowsRequest {
|
|
|
559
578
|
// time, set `missing_value_interpretations` to `NULL_VALUE` on those columns.
|
|
560
579
|
MissingValueInterpretation default_missing_value_interpretation = 8
|
|
561
580
|
[(google.api.field_behavior) = OPTIONAL];
|
|
581
|
+
|
|
582
|
+
// Optional. Stats and telemetry data gathered on the client side.
|
|
583
|
+
ClientStats client_stats = 9 [(google.api.field_behavior) = OPTIONAL];
|
|
562
584
|
}
|
|
563
585
|
|
|
564
586
|
// Response message for `AppendRows`.
|
|
@@ -784,3 +806,68 @@ message RowError {
|
|
|
784
806
|
// Description of the issue encountered when processing the row.
|
|
785
807
|
string message = 3;
|
|
786
808
|
}
|
|
809
|
+
|
|
810
|
+
// Stats and telemetry data gathered on the client side about requests
|
|
811
|
+
// being sent to the BigQuery Storage service, for internal use only.
|
|
812
|
+
message ClientStats {
|
|
813
|
+
// Stats and telemetry data gathered on the client side about a single
|
|
814
|
+
// request.
|
|
815
|
+
message RequestStats {
|
|
816
|
+
// Optional. Timestamp indicating when the request was sent over the
|
|
817
|
+
// network, expressed in epoch milliseconds.
|
|
818
|
+
optional int64 send_time_millis = 1
|
|
819
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
820
|
+
|
|
821
|
+
// Optional. Number of pending requests at the moment this request was sent.
|
|
822
|
+
// This includes requests waiting to be sent, and those that are inflight.
|
|
823
|
+
optional int64 queued_requests_count = 2
|
|
824
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
825
|
+
}
|
|
826
|
+
|
|
827
|
+
// Aggregate connection metrics over a window interval.
|
|
828
|
+
message WindowStats {
|
|
829
|
+
// Optional. The maximum response latency observed in the window, expressed
|
|
830
|
+
// in milliseconds.
|
|
831
|
+
optional int64 max_response_latency_millis = 1
|
|
832
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
833
|
+
|
|
834
|
+
// Optional. The average response latency observed in the window, expressed
|
|
835
|
+
// in milliseconds.
|
|
836
|
+
optional int64 avg_response_latency_millis = 2
|
|
837
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
838
|
+
|
|
839
|
+
// Optional. The longest time spent waiting without receiving a response in
|
|
840
|
+
// the window. This could exceed max_response_latency_millis because the
|
|
841
|
+
// latter is evaluated only when a response is received. Expressed in
|
|
842
|
+
// milliseconds.
|
|
843
|
+
optional int64 longest_wait_no_response_millis = 3
|
|
844
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
845
|
+
|
|
846
|
+
// Optional. How many requests were sent in the window.
|
|
847
|
+
optional int64 requests_sent_count = 4
|
|
848
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
849
|
+
|
|
850
|
+
// Optional. How many responses were received in the window.
|
|
851
|
+
optional int64 responses_received_count = 5
|
|
852
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
853
|
+
|
|
854
|
+
// Optional. How many bytes were sent in the window.
|
|
855
|
+
optional int64 bytes_sent_count = 6
|
|
856
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
857
|
+
|
|
858
|
+
// Optional. Start time of the window interval for which these stats are
|
|
859
|
+
// aggregated, expressed in epoch milliseconds.
|
|
860
|
+
optional int64 window_start_time_epoch_millis = 7
|
|
861
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
862
|
+
|
|
863
|
+
// Optional. Duration of the window interval for which these stats are
|
|
864
|
+
// aggregated, expressed in milliseconds.
|
|
865
|
+
optional int64 window_millis = 8 [(google.api.field_behavior) = OPTIONAL];
|
|
866
|
+
}
|
|
867
|
+
|
|
868
|
+
// Optional. Per-request stats.
|
|
869
|
+
RequestStats request_stats = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
870
|
+
|
|
871
|
+
// Optional. Windowed stats.
|
|
872
|
+
WindowStats window_stats = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
873
|
+
}
|
package/build/protos/protos.d.ts
CHANGED
|
@@ -1218,6 +1218,9 @@ export namespace google {
|
|
|
1218
1218
|
|
|
1219
1219
|
/** ReadRowsRequest offset */
|
|
1220
1220
|
offset?: (number|Long|string|null);
|
|
1221
|
+
|
|
1222
|
+
/** ReadRowsRequest arrowSerializationOptions */
|
|
1223
|
+
arrowSerializationOptions?: (google.cloud.bigquery.storage.v1.IArrowSerializationOptions|null);
|
|
1221
1224
|
}
|
|
1222
1225
|
|
|
1223
1226
|
/** Represents a ReadRowsRequest. */
|
|
@@ -1235,6 +1238,12 @@ export namespace google {
|
|
|
1235
1238
|
/** ReadRowsRequest offset. */
|
|
1236
1239
|
public offset: (number|Long|string);
|
|
1237
1240
|
|
|
1241
|
+
/** ReadRowsRequest arrowSerializationOptions. */
|
|
1242
|
+
public arrowSerializationOptions?: (google.cloud.bigquery.storage.v1.IArrowSerializationOptions|null);
|
|
1243
|
+
|
|
1244
|
+
/** ReadRowsRequest outputFormatSerializationOptions. */
|
|
1245
|
+
public outputFormatSerializationOptions?: "arrowSerializationOptions";
|
|
1246
|
+
|
|
1238
1247
|
/**
|
|
1239
1248
|
* Creates a new ReadRowsRequest instance using the specified properties.
|
|
1240
1249
|
* @param [properties] Properties to set
|
|
@@ -1639,6 +1648,9 @@ export namespace google {
|
|
|
1639
1648
|
|
|
1640
1649
|
/** ReadRowsResponse uncompressedByteSize */
|
|
1641
1650
|
uncompressedByteSize?: (number|Long|string|null);
|
|
1651
|
+
|
|
1652
|
+
/** ReadRowsResponse totalEstimatedRowCount */
|
|
1653
|
+
totalEstimatedRowCount?: (number|Long|string|null);
|
|
1642
1654
|
}
|
|
1643
1655
|
|
|
1644
1656
|
/** Represents a ReadRowsResponse. */
|
|
@@ -1674,6 +1686,9 @@ export namespace google {
|
|
|
1674
1686
|
/** ReadRowsResponse uncompressedByteSize. */
|
|
1675
1687
|
public uncompressedByteSize?: (number|Long|string|null);
|
|
1676
1688
|
|
|
1689
|
+
/** ReadRowsResponse totalEstimatedRowCount. */
|
|
1690
|
+
public totalEstimatedRowCount?: (number|Long|string|null);
|
|
1691
|
+
|
|
1677
1692
|
/** ReadRowsResponse rows. */
|
|
1678
1693
|
public rows?: ("avroRows"|"arrowRecordBatch");
|
|
1679
1694
|
|
|
@@ -2090,6 +2105,9 @@ export namespace google {
|
|
|
2090
2105
|
|
|
2091
2106
|
/** AppendRowsRequest defaultMissingValueInterpretation */
|
|
2092
2107
|
defaultMissingValueInterpretation?: (google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation|keyof typeof google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation|null);
|
|
2108
|
+
|
|
2109
|
+
/** AppendRowsRequest clientStats */
|
|
2110
|
+
clientStats?: (google.cloud.bigquery.storage.v1.IClientStats|null);
|
|
2093
2111
|
}
|
|
2094
2112
|
|
|
2095
2113
|
/** Represents an AppendRowsRequest. */
|
|
@@ -2122,6 +2140,9 @@ export namespace google {
|
|
|
2122
2140
|
/** AppendRowsRequest defaultMissingValueInterpretation. */
|
|
2123
2141
|
public defaultMissingValueInterpretation: (google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation|keyof typeof google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation);
|
|
2124
2142
|
|
|
2143
|
+
/** AppendRowsRequest clientStats. */
|
|
2144
|
+
public clientStats?: (google.cloud.bigquery.storage.v1.IClientStats|null);
|
|
2145
|
+
|
|
2125
2146
|
/** AppendRowsRequest rows. */
|
|
2126
2147
|
public rows?: ("protoRows"|"arrowRows");
|
|
2127
2148
|
|
|
@@ -3595,6 +3616,354 @@ export namespace google {
|
|
|
3595
3616
|
}
|
|
3596
3617
|
}
|
|
3597
3618
|
|
|
3619
|
+
/** Properties of a ClientStats. */
|
|
3620
|
+
interface IClientStats {
|
|
3621
|
+
|
|
3622
|
+
/** ClientStats requestStats */
|
|
3623
|
+
requestStats?: (google.cloud.bigquery.storage.v1.ClientStats.IRequestStats|null);
|
|
3624
|
+
|
|
3625
|
+
/** ClientStats windowStats */
|
|
3626
|
+
windowStats?: (google.cloud.bigquery.storage.v1.ClientStats.IWindowStats|null);
|
|
3627
|
+
}
|
|
3628
|
+
|
|
3629
|
+
/** Represents a ClientStats. */
|
|
3630
|
+
class ClientStats implements IClientStats {
|
|
3631
|
+
|
|
3632
|
+
/**
|
|
3633
|
+
* Constructs a new ClientStats.
|
|
3634
|
+
* @param [properties] Properties to set
|
|
3635
|
+
*/
|
|
3636
|
+
constructor(properties?: google.cloud.bigquery.storage.v1.IClientStats);
|
|
3637
|
+
|
|
3638
|
+
/** ClientStats requestStats. */
|
|
3639
|
+
public requestStats?: (google.cloud.bigquery.storage.v1.ClientStats.IRequestStats|null);
|
|
3640
|
+
|
|
3641
|
+
/** ClientStats windowStats. */
|
|
3642
|
+
public windowStats?: (google.cloud.bigquery.storage.v1.ClientStats.IWindowStats|null);
|
|
3643
|
+
|
|
3644
|
+
/**
|
|
3645
|
+
* Creates a new ClientStats instance using the specified properties.
|
|
3646
|
+
* @param [properties] Properties to set
|
|
3647
|
+
* @returns ClientStats instance
|
|
3648
|
+
*/
|
|
3649
|
+
public static create(properties?: google.cloud.bigquery.storage.v1.IClientStats): google.cloud.bigquery.storage.v1.ClientStats;
|
|
3650
|
+
|
|
3651
|
+
/**
|
|
3652
|
+
* Encodes the specified ClientStats message. Does not implicitly {@link google.cloud.bigquery.storage.v1.ClientStats.verify|verify} messages.
|
|
3653
|
+
* @param message ClientStats message or plain object to encode
|
|
3654
|
+
* @param [writer] Writer to encode to
|
|
3655
|
+
* @returns Writer
|
|
3656
|
+
*/
|
|
3657
|
+
public static encode(message: google.cloud.bigquery.storage.v1.IClientStats, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
3658
|
+
|
|
3659
|
+
/**
|
|
3660
|
+
* Encodes the specified ClientStats message, length delimited. Does not implicitly {@link google.cloud.bigquery.storage.v1.ClientStats.verify|verify} messages.
|
|
3661
|
+
* @param message ClientStats message or plain object to encode
|
|
3662
|
+
* @param [writer] Writer to encode to
|
|
3663
|
+
* @returns Writer
|
|
3664
|
+
*/
|
|
3665
|
+
public static encodeDelimited(message: google.cloud.bigquery.storage.v1.IClientStats, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
3666
|
+
|
|
3667
|
+
/**
|
|
3668
|
+
* Decodes a ClientStats message from the specified reader or buffer.
|
|
3669
|
+
* @param reader Reader or buffer to decode from
|
|
3670
|
+
* @param [length] Message length if known beforehand
|
|
3671
|
+
* @returns ClientStats
|
|
3672
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
3673
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
3674
|
+
*/
|
|
3675
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.storage.v1.ClientStats;
|
|
3676
|
+
|
|
3677
|
+
/**
|
|
3678
|
+
* Decodes a ClientStats message from the specified reader or buffer, length delimited.
|
|
3679
|
+
* @param reader Reader or buffer to decode from
|
|
3680
|
+
* @returns ClientStats
|
|
3681
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
3682
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
3683
|
+
*/
|
|
3684
|
+
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.storage.v1.ClientStats;
|
|
3685
|
+
|
|
3686
|
+
/**
|
|
3687
|
+
* Verifies a ClientStats message.
|
|
3688
|
+
* @param message Plain object to verify
|
|
3689
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
3690
|
+
*/
|
|
3691
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
3692
|
+
|
|
3693
|
+
/**
|
|
3694
|
+
* Creates a ClientStats message from a plain object. Also converts values to their respective internal types.
|
|
3695
|
+
* @param object Plain object
|
|
3696
|
+
* @returns ClientStats
|
|
3697
|
+
*/
|
|
3698
|
+
public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.storage.v1.ClientStats;
|
|
3699
|
+
|
|
3700
|
+
/**
|
|
3701
|
+
* Creates a plain object from a ClientStats message. Also converts values to other types if specified.
|
|
3702
|
+
* @param message ClientStats
|
|
3703
|
+
* @param [options] Conversion options
|
|
3704
|
+
* @returns Plain object
|
|
3705
|
+
*/
|
|
3706
|
+
public static toObject(message: google.cloud.bigquery.storage.v1.ClientStats, options?: $protobuf.IConversionOptions): { [k: string]: any };
|
|
3707
|
+
|
|
3708
|
+
/**
|
|
3709
|
+
* Converts this ClientStats to JSON.
|
|
3710
|
+
* @returns JSON object
|
|
3711
|
+
*/
|
|
3712
|
+
public toJSON(): { [k: string]: any };
|
|
3713
|
+
|
|
3714
|
+
/**
|
|
3715
|
+
* Gets the default type url for ClientStats
|
|
3716
|
+
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
|
|
3717
|
+
* @returns The default type url
|
|
3718
|
+
*/
|
|
3719
|
+
public static getTypeUrl(typeUrlPrefix?: string): string;
|
|
3720
|
+
}
|
|
3721
|
+
|
|
3722
|
+
namespace ClientStats {
|
|
3723
|
+
|
|
3724
|
+
/** Properties of a RequestStats. */
|
|
3725
|
+
interface IRequestStats {
|
|
3726
|
+
|
|
3727
|
+
/** RequestStats sendTimeMillis */
|
|
3728
|
+
sendTimeMillis?: (number|Long|string|null);
|
|
3729
|
+
|
|
3730
|
+
/** RequestStats queuedRequestsCount */
|
|
3731
|
+
queuedRequestsCount?: (number|Long|string|null);
|
|
3732
|
+
}
|
|
3733
|
+
|
|
3734
|
+
/** Represents a RequestStats. */
|
|
3735
|
+
class RequestStats implements IRequestStats {
|
|
3736
|
+
|
|
3737
|
+
/**
|
|
3738
|
+
* Constructs a new RequestStats.
|
|
3739
|
+
* @param [properties] Properties to set
|
|
3740
|
+
*/
|
|
3741
|
+
constructor(properties?: google.cloud.bigquery.storage.v1.ClientStats.IRequestStats);
|
|
3742
|
+
|
|
3743
|
+
/** RequestStats sendTimeMillis. */
|
|
3744
|
+
public sendTimeMillis?: (number|Long|string|null);
|
|
3745
|
+
|
|
3746
|
+
/** RequestStats queuedRequestsCount. */
|
|
3747
|
+
public queuedRequestsCount?: (number|Long|string|null);
|
|
3748
|
+
|
|
3749
|
+
/**
|
|
3750
|
+
* Creates a new RequestStats instance using the specified properties.
|
|
3751
|
+
* @param [properties] Properties to set
|
|
3752
|
+
* @returns RequestStats instance
|
|
3753
|
+
*/
|
|
3754
|
+
public static create(properties?: google.cloud.bigquery.storage.v1.ClientStats.IRequestStats): google.cloud.bigquery.storage.v1.ClientStats.RequestStats;
|
|
3755
|
+
|
|
3756
|
+
/**
|
|
3757
|
+
* Encodes the specified RequestStats message. Does not implicitly {@link google.cloud.bigquery.storage.v1.ClientStats.RequestStats.verify|verify} messages.
|
|
3758
|
+
* @param message RequestStats message or plain object to encode
|
|
3759
|
+
* @param [writer] Writer to encode to
|
|
3760
|
+
* @returns Writer
|
|
3761
|
+
*/
|
|
3762
|
+
public static encode(message: google.cloud.bigquery.storage.v1.ClientStats.IRequestStats, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
3763
|
+
|
|
3764
|
+
/**
|
|
3765
|
+
* Encodes the specified RequestStats message, length delimited. Does not implicitly {@link google.cloud.bigquery.storage.v1.ClientStats.RequestStats.verify|verify} messages.
|
|
3766
|
+
* @param message RequestStats message or plain object to encode
|
|
3767
|
+
* @param [writer] Writer to encode to
|
|
3768
|
+
* @returns Writer
|
|
3769
|
+
*/
|
|
3770
|
+
public static encodeDelimited(message: google.cloud.bigquery.storage.v1.ClientStats.IRequestStats, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
3771
|
+
|
|
3772
|
+
/**
|
|
3773
|
+
* Decodes a RequestStats message from the specified reader or buffer.
|
|
3774
|
+
* @param reader Reader or buffer to decode from
|
|
3775
|
+
* @param [length] Message length if known beforehand
|
|
3776
|
+
* @returns RequestStats
|
|
3777
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
3778
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
3779
|
+
*/
|
|
3780
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.storage.v1.ClientStats.RequestStats;
|
|
3781
|
+
|
|
3782
|
+
/**
|
|
3783
|
+
* Decodes a RequestStats message from the specified reader or buffer, length delimited.
|
|
3784
|
+
* @param reader Reader or buffer to decode from
|
|
3785
|
+
* @returns RequestStats
|
|
3786
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
3787
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
3788
|
+
*/
|
|
3789
|
+
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.storage.v1.ClientStats.RequestStats;
|
|
3790
|
+
|
|
3791
|
+
/**
|
|
3792
|
+
* Verifies a RequestStats message.
|
|
3793
|
+
* @param message Plain object to verify
|
|
3794
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
3795
|
+
*/
|
|
3796
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
3797
|
+
|
|
3798
|
+
/**
|
|
3799
|
+
* Creates a RequestStats message from a plain object. Also converts values to their respective internal types.
|
|
3800
|
+
* @param object Plain object
|
|
3801
|
+
* @returns RequestStats
|
|
3802
|
+
*/
|
|
3803
|
+
public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.storage.v1.ClientStats.RequestStats;
|
|
3804
|
+
|
|
3805
|
+
/**
|
|
3806
|
+
* Creates a plain object from a RequestStats message. Also converts values to other types if specified.
|
|
3807
|
+
* @param message RequestStats
|
|
3808
|
+
* @param [options] Conversion options
|
|
3809
|
+
* @returns Plain object
|
|
3810
|
+
*/
|
|
3811
|
+
public static toObject(message: google.cloud.bigquery.storage.v1.ClientStats.RequestStats, options?: $protobuf.IConversionOptions): { [k: string]: any };
|
|
3812
|
+
|
|
3813
|
+
/**
|
|
3814
|
+
* Converts this RequestStats to JSON.
|
|
3815
|
+
* @returns JSON object
|
|
3816
|
+
*/
|
|
3817
|
+
public toJSON(): { [k: string]: any };
|
|
3818
|
+
|
|
3819
|
+
/**
|
|
3820
|
+
* Gets the default type url for RequestStats
|
|
3821
|
+
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
|
|
3822
|
+
* @returns The default type url
|
|
3823
|
+
*/
|
|
3824
|
+
public static getTypeUrl(typeUrlPrefix?: string): string;
|
|
3825
|
+
}
|
|
3826
|
+
|
|
3827
|
+
/** Properties of a WindowStats. */
|
|
3828
|
+
interface IWindowStats {
|
|
3829
|
+
|
|
3830
|
+
/** WindowStats maxResponseLatencyMillis */
|
|
3831
|
+
maxResponseLatencyMillis?: (number|Long|string|null);
|
|
3832
|
+
|
|
3833
|
+
/** WindowStats avgResponseLatencyMillis */
|
|
3834
|
+
avgResponseLatencyMillis?: (number|Long|string|null);
|
|
3835
|
+
|
|
3836
|
+
/** WindowStats longestWaitNoResponseMillis */
|
|
3837
|
+
longestWaitNoResponseMillis?: (number|Long|string|null);
|
|
3838
|
+
|
|
3839
|
+
/** WindowStats requestsSentCount */
|
|
3840
|
+
requestsSentCount?: (number|Long|string|null);
|
|
3841
|
+
|
|
3842
|
+
/** WindowStats responsesReceivedCount */
|
|
3843
|
+
responsesReceivedCount?: (number|Long|string|null);
|
|
3844
|
+
|
|
3845
|
+
/** WindowStats bytesSentCount */
|
|
3846
|
+
bytesSentCount?: (number|Long|string|null);
|
|
3847
|
+
|
|
3848
|
+
/** WindowStats windowStartTimeEpochMillis */
|
|
3849
|
+
windowStartTimeEpochMillis?: (number|Long|string|null);
|
|
3850
|
+
|
|
3851
|
+
/** WindowStats windowMillis */
|
|
3852
|
+
windowMillis?: (number|Long|string|null);
|
|
3853
|
+
}
|
|
3854
|
+
|
|
3855
|
+
/** Represents a WindowStats. */
|
|
3856
|
+
class WindowStats implements IWindowStats {
|
|
3857
|
+
|
|
3858
|
+
/**
|
|
3859
|
+
* Constructs a new WindowStats.
|
|
3860
|
+
* @param [properties] Properties to set
|
|
3861
|
+
*/
|
|
3862
|
+
constructor(properties?: google.cloud.bigquery.storage.v1.ClientStats.IWindowStats);
|
|
3863
|
+
|
|
3864
|
+
/** WindowStats maxResponseLatencyMillis. */
|
|
3865
|
+
public maxResponseLatencyMillis?: (number|Long|string|null);
|
|
3866
|
+
|
|
3867
|
+
/** WindowStats avgResponseLatencyMillis. */
|
|
3868
|
+
public avgResponseLatencyMillis?: (number|Long|string|null);
|
|
3869
|
+
|
|
3870
|
+
/** WindowStats longestWaitNoResponseMillis. */
|
|
3871
|
+
public longestWaitNoResponseMillis?: (number|Long|string|null);
|
|
3872
|
+
|
|
3873
|
+
/** WindowStats requestsSentCount. */
|
|
3874
|
+
public requestsSentCount?: (number|Long|string|null);
|
|
3875
|
+
|
|
3876
|
+
/** WindowStats responsesReceivedCount. */
|
|
3877
|
+
public responsesReceivedCount?: (number|Long|string|null);
|
|
3878
|
+
|
|
3879
|
+
/** WindowStats bytesSentCount. */
|
|
3880
|
+
public bytesSentCount?: (number|Long|string|null);
|
|
3881
|
+
|
|
3882
|
+
/** WindowStats windowStartTimeEpochMillis. */
|
|
3883
|
+
public windowStartTimeEpochMillis?: (number|Long|string|null);
|
|
3884
|
+
|
|
3885
|
+
/** WindowStats windowMillis. */
|
|
3886
|
+
public windowMillis?: (number|Long|string|null);
|
|
3887
|
+
|
|
3888
|
+
/**
|
|
3889
|
+
* Creates a new WindowStats instance using the specified properties.
|
|
3890
|
+
* @param [properties] Properties to set
|
|
3891
|
+
* @returns WindowStats instance
|
|
3892
|
+
*/
|
|
3893
|
+
public static create(properties?: google.cloud.bigquery.storage.v1.ClientStats.IWindowStats): google.cloud.bigquery.storage.v1.ClientStats.WindowStats;
|
|
3894
|
+
|
|
3895
|
+
/**
|
|
3896
|
+
* Encodes the specified WindowStats message. Does not implicitly {@link google.cloud.bigquery.storage.v1.ClientStats.WindowStats.verify|verify} messages.
|
|
3897
|
+
* @param message WindowStats message or plain object to encode
|
|
3898
|
+
* @param [writer] Writer to encode to
|
|
3899
|
+
* @returns Writer
|
|
3900
|
+
*/
|
|
3901
|
+
public static encode(message: google.cloud.bigquery.storage.v1.ClientStats.IWindowStats, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
3902
|
+
|
|
3903
|
+
/**
|
|
3904
|
+
* Encodes the specified WindowStats message, length delimited. Does not implicitly {@link google.cloud.bigquery.storage.v1.ClientStats.WindowStats.verify|verify} messages.
|
|
3905
|
+
* @param message WindowStats message or plain object to encode
|
|
3906
|
+
* @param [writer] Writer to encode to
|
|
3907
|
+
* @returns Writer
|
|
3908
|
+
*/
|
|
3909
|
+
public static encodeDelimited(message: google.cloud.bigquery.storage.v1.ClientStats.IWindowStats, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
3910
|
+
|
|
3911
|
+
/**
|
|
3912
|
+
* Decodes a WindowStats message from the specified reader or buffer.
|
|
3913
|
+
* @param reader Reader or buffer to decode from
|
|
3914
|
+
* @param [length] Message length if known beforehand
|
|
3915
|
+
* @returns WindowStats
|
|
3916
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
3917
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
3918
|
+
*/
|
|
3919
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.storage.v1.ClientStats.WindowStats;
|
|
3920
|
+
|
|
3921
|
+
/**
|
|
3922
|
+
* Decodes a WindowStats message from the specified reader or buffer, length delimited.
|
|
3923
|
+
* @param reader Reader or buffer to decode from
|
|
3924
|
+
* @returns WindowStats
|
|
3925
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
3926
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
3927
|
+
*/
|
|
3928
|
+
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.storage.v1.ClientStats.WindowStats;
|
|
3929
|
+
|
|
3930
|
+
/**
|
|
3931
|
+
* Verifies a WindowStats message.
|
|
3932
|
+
* @param message Plain object to verify
|
|
3933
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
3934
|
+
*/
|
|
3935
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
3936
|
+
|
|
3937
|
+
/**
|
|
3938
|
+
* Creates a WindowStats message from a plain object. Also converts values to their respective internal types.
|
|
3939
|
+
* @param object Plain object
|
|
3940
|
+
* @returns WindowStats
|
|
3941
|
+
*/
|
|
3942
|
+
public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.storage.v1.ClientStats.WindowStats;
|
|
3943
|
+
|
|
3944
|
+
/**
|
|
3945
|
+
* Creates a plain object from a WindowStats message. Also converts values to other types if specified.
|
|
3946
|
+
* @param message WindowStats
|
|
3947
|
+
* @param [options] Conversion options
|
|
3948
|
+
* @returns Plain object
|
|
3949
|
+
*/
|
|
3950
|
+
public static toObject(message: google.cloud.bigquery.storage.v1.ClientStats.WindowStats, options?: $protobuf.IConversionOptions): { [k: string]: any };
|
|
3951
|
+
|
|
3952
|
+
/**
|
|
3953
|
+
* Converts this WindowStats to JSON.
|
|
3954
|
+
* @returns JSON object
|
|
3955
|
+
*/
|
|
3956
|
+
public toJSON(): { [k: string]: any };
|
|
3957
|
+
|
|
3958
|
+
/**
|
|
3959
|
+
* Gets the default type url for WindowStats
|
|
3960
|
+
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
|
|
3961
|
+
* @returns The default type url
|
|
3962
|
+
*/
|
|
3963
|
+
public static getTypeUrl(typeUrlPrefix?: string): string;
|
|
3964
|
+
}
|
|
3965
|
+
}
|
|
3966
|
+
|
|
3598
3967
|
/** DataFormat enum. */
|
|
3599
3968
|
enum DataFormat {
|
|
3600
3969
|
DATA_FORMAT_UNSPECIFIED = 0,
|