@google-cloud/bigquery-storage-api 0.1.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/README.md +111 -0
- package/build/protos/google/cloud/bigquery/storage/v1/annotations.proto +28 -0
- package/build/protos/google/cloud/bigquery/storage/v1/arrow.proto +89 -0
- package/build/protos/google/cloud/bigquery/storage/v1/avro.proto +81 -0
- package/build/protos/google/cloud/bigquery/storage/v1/protobuf.proto +48 -0
- package/build/protos/google/cloud/bigquery/storage/v1/storage.proto +786 -0
- package/build/protos/google/cloud/bigquery/storage/v1/stream.proto +335 -0
- package/build/protos/google/cloud/bigquery/storage/v1/table.proto +200 -0
- package/build/protos/protos.d.ts +12699 -0
- package/build/protos/protos.js +1 -0
- package/build/protos/protos.json +1 -0
- package/build/src/index.d.ts +14 -0
- package/build/src/index.js +30 -0
- package/build/src/index.js.map +1 -0
- package/build/src/v1/big_query_read_client.d.ts +424 -0
- package/build/src/v1/big_query_read_client.js +689 -0
- package/build/src/v1/big_query_read_client.js.map +1 -0
- package/build/src/v1/big_query_read_client_config.json +44 -0
- package/build/src/v1/big_query_read_proto_list.json +9 -0
- package/build/src/v1/big_query_write_client.d.ts +486 -0
- package/build/src/v1/big_query_write_client.js +835 -0
- package/build/src/v1/big_query_write_client.js.map +1 -0
- package/build/src/v1/big_query_write_client_config.json +73 -0
- package/build/src/v1/big_query_write_proto_list.json +9 -0
- package/build/src/v1/gapic_metadata.json +117 -0
- package/build/src/v1/index.d.ts +2 -0
- package/build/src/v1/index.js +25 -0
- package/build/src/v1/index.js.map +1 -0
- package/package.json +66 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"nested":{"google":{"nested":{"cloud":{"nested":{"bigquery":{"nested":{"storage":{"nested":{"v1":{"options":{"csharp_namespace":"Google.Cloud.BigQuery.Storage.V1","go_package":"cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb","java_package":"com.google.cloud.bigquery.storage.v1","java_multiple_files":true,"java_outer_classname":"TableProto","php_namespace":"Google\\Cloud\\BigQuery\\Storage\\V1","(google.api.resource_definition).type":"bigquery.googleapis.com/Table","(google.api.resource_definition).pattern":"projects/{project}/datasets/{dataset}/tables/{table}"},"nested":{"_columnName":{"oneof":["columnName"]},"columnName":{"type":"string","id":454943157,"extend":"google.protobuf.FieldOptions","options":{"proto3_optional":true}},"ArrowSchema":{"fields":{"serializedSchema":{"type":"bytes","id":1}}},"ArrowRecordBatch":{"fields":{"serializedRecordBatch":{"type":"bytes","id":1},"rowCount":{"type":"int64","id":2,"options":{"deprecated":true}}}},"ArrowSerializationOptions":{"fields":{"bufferCompression":{"type":"CompressionCodec","id":2},"picosTimestampPrecision":{"type":"PicosTimestampPrecision","id":3}},"nested":{"CompressionCodec":{"values":{"COMPRESSION_UNSPECIFIED":0,"LZ4_FRAME":1,"ZSTD":2}},"PicosTimestampPrecision":{"values":{"PICOS_TIMESTAMP_PRECISION_UNSPECIFIED":0,"TIMESTAMP_PRECISION_MICROS":1,"TIMESTAMP_PRECISION_NANOS":2,"TIMESTAMP_PRECISION_PICOS":3}}}},"AvroSchema":{"fields":{"schema":{"type":"string","id":1}}},"AvroRows":{"fields":{"serializedBinaryRows":{"type":"bytes","id":1},"rowCount":{"type":"int64","id":2,"options":{"deprecated":true}}}},"AvroSerializationOptions":{"fields":{"enableDisplayNameAttribute":{"type":"bool","id":1},"picosTimestampPrecision":{"type":"PicosTimestampPrecision","id":2}},"nested":{"PicosTimestampPrecision":{"values":{"PICOS_TIMESTAMP_PRECISION_UNSPECIFIED":0,"TIMESTAMP_PRECISION_MICROS":1,"TIMESTAMP_PRECISION_NANOS":2,"TIMESTAMP_PRECISION_PICOS":3}}}},"ProtoSchema":{"fields":{"protoDescriptor":{"type":"google.protobuf.DescriptorProto","id":1}}},"ProtoRows":{"fields":{"serializedRows":{"rule":"repeated","type":"bytes","id":1}}},"BigQueryRead":{"options":{"(google.api.default_host)":"bigquerystorage.googleapis.com","(google.api.oauth_scopes)":"https://www.googleapis.com/auth/bigquery,https://www.googleapis.com/auth/cloud-platform"},"methods":{"CreateReadSession":{"requestType":"CreateReadSessionRequest","responseType":"ReadSession","options":{"(google.api.http).post":"/v1/{read_session.table=projects/*/datasets/*/tables/*}","(google.api.http).body":"*","(google.api.method_signature)":"parent,read_session,max_stream_count"},"parsedOptions":[{"(google.api.http)":{"post":"/v1/{read_session.table=projects/*/datasets/*/tables/*}","body":"*"}},{"(google.api.method_signature)":"parent,read_session,max_stream_count"}]},"ReadRows":{"requestType":"ReadRowsRequest","responseType":"ReadRowsResponse","responseStream":true,"options":{"(google.api.http).get":"/v1/{read_stream=projects/*/locations/*/sessions/*/streams/*}","(google.api.method_signature)":"read_stream,offset"},"parsedOptions":[{"(google.api.http)":{"get":"/v1/{read_stream=projects/*/locations/*/sessions/*/streams/*}"}},{"(google.api.method_signature)":"read_stream,offset"}]},"SplitReadStream":{"requestType":"SplitReadStreamRequest","responseType":"SplitReadStreamResponse","options":{"(google.api.http).get":"/v1/{name=projects/*/locations/*/sessions/*/streams/*}"},"parsedOptions":[{"(google.api.http)":{"get":"/v1/{name=projects/*/locations/*/sessions/*/streams/*}"}}]}}},"BigQueryWrite":{"options":{"(google.api.default_host)":"bigquerystorage.googleapis.com","(google.api.oauth_scopes)":"https://www.googleapis.com/auth/bigquery,https://www.googleapis.com/auth/bigquery.insertdata,https://www.googleapis.com/auth/cloud-platform"},"methods":{"CreateWriteStream":{"requestType":"CreateWriteStreamRequest","responseType":"WriteStream","options":{"(google.api.http).post":"/v1/{parent=projects/*/datasets/*/tables/*}","(google.api.http).body":"write_stream","(google.api.method_signature)":"parent,write_stream"},"parsedOptions":[{"(google.api.http)":{"post":"/v1/{parent=projects/*/datasets/*/tables/*}","body":"write_stream"}},{"(google.api.method_signature)":"parent,write_stream"}]},"AppendRows":{"requestType":"AppendRowsRequest","requestStream":true,"responseType":"AppendRowsResponse","responseStream":true,"options":{"(google.api.http).post":"/v1/{write_stream=projects/*/datasets/*/tables/*/streams/*}","(google.api.http).body":"*","(google.api.method_signature)":"write_stream"},"parsedOptions":[{"(google.api.http)":{"post":"/v1/{write_stream=projects/*/datasets/*/tables/*/streams/*}","body":"*"}},{"(google.api.method_signature)":"write_stream"}]},"GetWriteStream":{"requestType":"GetWriteStreamRequest","responseType":"WriteStream","options":{"(google.api.http).post":"/v1/{name=projects/*/datasets/*/tables/*/streams/*}","(google.api.http).body":"*","(google.api.method_signature)":"name"},"parsedOptions":[{"(google.api.http)":{"post":"/v1/{name=projects/*/datasets/*/tables/*/streams/*}","body":"*"}},{"(google.api.method_signature)":"name"}]},"FinalizeWriteStream":{"requestType":"FinalizeWriteStreamRequest","responseType":"FinalizeWriteStreamResponse","options":{"(google.api.http).post":"/v1/{name=projects/*/datasets/*/tables/*/streams/*}","(google.api.http).body":"*","(google.api.method_signature)":"name"},"parsedOptions":[{"(google.api.http)":{"post":"/v1/{name=projects/*/datasets/*/tables/*/streams/*}","body":"*"}},{"(google.api.method_signature)":"name"}]},"BatchCommitWriteStreams":{"requestType":"BatchCommitWriteStreamsRequest","responseType":"BatchCommitWriteStreamsResponse","options":{"(google.api.http).get":"/v1/{parent=projects/*/datasets/*/tables/*}","(google.api.method_signature)":"parent"},"parsedOptions":[{"(google.api.http)":{"get":"/v1/{parent=projects/*/datasets/*/tables/*}"}},{"(google.api.method_signature)":"parent"}]},"FlushRows":{"requestType":"FlushRowsRequest","responseType":"FlushRowsResponse","options":{"(google.api.http).post":"/v1/{write_stream=projects/*/datasets/*/tables/*/streams/*}","(google.api.http).body":"*","(google.api.method_signature)":"write_stream"},"parsedOptions":[{"(google.api.http)":{"post":"/v1/{write_stream=projects/*/datasets/*/tables/*/streams/*}","body":"*"}},{"(google.api.method_signature)":"write_stream"}]}}},"CreateReadSessionRequest":{"fields":{"parent":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"cloudresourcemanager.googleapis.com/Project"}},"readSession":{"type":"ReadSession","id":2,"options":{"(google.api.field_behavior)":"REQUIRED"}},"maxStreamCount":{"type":"int32","id":3},"preferredMinStreamCount":{"type":"int32","id":4}}},"ReadRowsRequest":{"fields":{"readStream":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"bigquerystorage.googleapis.com/ReadStream"}},"offset":{"type":"int64","id":2}}},"ThrottleState":{"fields":{"throttlePercent":{"type":"int32","id":1}}},"StreamStats":{"fields":{"progress":{"type":"Progress","id":2}},"nested":{"Progress":{"fields":{"atResponseStart":{"type":"double","id":1},"atResponseEnd":{"type":"double","id":2}}}}},"ReadRowsResponse":{"oneofs":{"rows":{"oneof":["avroRows","arrowRecordBatch"]},"schema":{"oneof":["avroSchema","arrowSchema"]},"_uncompressedByteSize":{"oneof":["uncompressedByteSize"]}},"fields":{"avroRows":{"type":"AvroRows","id":3},"arrowRecordBatch":{"type":"ArrowRecordBatch","id":4},"rowCount":{"type":"int64","id":6},"stats":{"type":"StreamStats","id":2},"throttleState":{"type":"ThrottleState","id":5},"avroSchema":{"type":"AvroSchema","id":7,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"arrowSchema":{"type":"ArrowSchema","id":8,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"uncompressedByteSize":{"type":"int64","id":9,"options":{"(google.api.field_behavior)":"OPTIONAL","proto3_optional":true}}}},"SplitReadStreamRequest":{"fields":{"name":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"bigquerystorage.googleapis.com/ReadStream"}},"fraction":{"type":"double","id":2}}},"SplitReadStreamResponse":{"fields":{"primaryStream":{"type":"ReadStream","id":1},"remainderStream":{"type":"ReadStream","id":2}}},"CreateWriteStreamRequest":{"fields":{"parent":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"bigquery.googleapis.com/Table"}},"writeStream":{"type":"WriteStream","id":2,"options":{"(google.api.field_behavior)":"REQUIRED"}}}},"AppendRowsRequest":{"oneofs":{"rows":{"oneof":["protoRows","arrowRows"]}},"fields":{"writeStream":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"bigquerystorage.googleapis.com/WriteStream"}},"offset":{"type":"google.protobuf.Int64Value","id":2},"protoRows":{"type":"ProtoData","id":4},"arrowRows":{"type":"ArrowData","id":5},"traceId":{"type":"string","id":6},"missingValueInterpretations":{"keyType":"string","type":"MissingValueInterpretation","id":7},"defaultMissingValueInterpretation":{"type":"MissingValueInterpretation","id":8,"options":{"(google.api.field_behavior)":"OPTIONAL"}}},"nested":{"ArrowData":{"fields":{"writerSchema":{"type":"ArrowSchema","id":1},"rows":{"type":"ArrowRecordBatch","id":2}}},"ProtoData":{"fields":{"writerSchema":{"type":"ProtoSchema","id":1},"rows":{"type":"ProtoRows","id":2}}},"MissingValueInterpretation":{"values":{"MISSING_VALUE_INTERPRETATION_UNSPECIFIED":0,"NULL_VALUE":1,"DEFAULT_VALUE":2}}}},"AppendRowsResponse":{"oneofs":{"response":{"oneof":["appendResult","error"]}},"fields":{"appendResult":{"type":"AppendResult","id":1},"error":{"type":"google.rpc.Status","id":2},"updatedSchema":{"type":"TableSchema","id":3},"rowErrors":{"rule":"repeated","type":"RowError","id":4},"writeStream":{"type":"string","id":5}},"nested":{"AppendResult":{"fields":{"offset":{"type":"google.protobuf.Int64Value","id":1}}}}},"GetWriteStreamRequest":{"fields":{"name":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"bigquerystorage.googleapis.com/WriteStream"}},"view":{"type":"WriteStreamView","id":3}}},"BatchCommitWriteStreamsRequest":{"fields":{"parent":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"bigquery.googleapis.com/Table"}},"writeStreams":{"rule":"repeated","type":"string","id":2,"options":{"(google.api.field_behavior)":"REQUIRED"}}}},"BatchCommitWriteStreamsResponse":{"fields":{"commitTime":{"type":"google.protobuf.Timestamp","id":1},"streamErrors":{"rule":"repeated","type":"StorageError","id":2}}},"FinalizeWriteStreamRequest":{"fields":{"name":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"bigquerystorage.googleapis.com/WriteStream"}}}},"FinalizeWriteStreamResponse":{"fields":{"rowCount":{"type":"int64","id":1}}},"FlushRowsRequest":{"fields":{"writeStream":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED","(google.api.resource_reference).type":"bigquerystorage.googleapis.com/WriteStream"}},"offset":{"type":"google.protobuf.Int64Value","id":2}}},"FlushRowsResponse":{"fields":{"offset":{"type":"int64","id":1}}},"StorageError":{"fields":{"code":{"type":"StorageErrorCode","id":1},"entity":{"type":"string","id":2},"errorMessage":{"type":"string","id":3}},"nested":{"StorageErrorCode":{"values":{"STORAGE_ERROR_CODE_UNSPECIFIED":0,"TABLE_NOT_FOUND":1,"STREAM_ALREADY_COMMITTED":2,"STREAM_NOT_FOUND":3,"INVALID_STREAM_TYPE":4,"INVALID_STREAM_STATE":5,"STREAM_FINALIZED":6,"SCHEMA_MISMATCH_EXTRA_FIELDS":7,"OFFSET_ALREADY_EXISTS":8,"OFFSET_OUT_OF_RANGE":9,"CMEK_NOT_PROVIDED":10,"INVALID_CMEK_PROVIDED":11,"CMEK_ENCRYPTION_ERROR":12,"KMS_SERVICE_ERROR":13,"KMS_PERMISSION_DENIED":14}}}},"RowError":{"fields":{"index":{"type":"int64","id":1},"code":{"type":"RowErrorCode","id":2},"message":{"type":"string","id":3}},"nested":{"RowErrorCode":{"values":{"ROW_ERROR_CODE_UNSPECIFIED":0,"FIELDS_ERROR":1}}}},"DataFormat":{"values":{"DATA_FORMAT_UNSPECIFIED":0,"AVRO":1,"ARROW":2}},"ReadSession":{"options":{"(google.api.resource).type":"bigquerystorage.googleapis.com/ReadSession","(google.api.resource).pattern":"projects/{project}/locations/{location}/sessions/{session}"},"oneofs":{"schema":{"oneof":["avroSchema","arrowSchema"]}},"fields":{"name":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"expireTime":{"type":"google.protobuf.Timestamp","id":2,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"dataFormat":{"type":"DataFormat","id":3,"options":{"(google.api.field_behavior)":"IMMUTABLE"}},"avroSchema":{"type":"AvroSchema","id":4,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"arrowSchema":{"type":"ArrowSchema","id":5,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"table":{"type":"string","id":6,"options":{"(google.api.field_behavior)":"IMMUTABLE","(google.api.resource_reference).type":"bigquery.googleapis.com/Table"}},"tableModifiers":{"type":"TableModifiers","id":7,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"readOptions":{"type":"TableReadOptions","id":8,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"streams":{"rule":"repeated","type":"ReadStream","id":10,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"estimatedTotalBytesScanned":{"type":"int64","id":12,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"estimatedTotalPhysicalFileSize":{"type":"int64","id":15,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"estimatedRowCount":{"type":"int64","id":14,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"traceId":{"type":"string","id":13,"options":{"(google.api.field_behavior)":"OPTIONAL"}}},"nested":{"TableModifiers":{"fields":{"snapshotTime":{"type":"google.protobuf.Timestamp","id":1}}},"TableReadOptions":{"oneofs":{"outputFormatSerializationOptions":{"oneof":["arrowSerializationOptions","avroSerializationOptions"]},"_samplePercentage":{"oneof":["samplePercentage"]},"_responseCompressionCodec":{"oneof":["responseCompressionCodec"]}},"fields":{"selectedFields":{"rule":"repeated","type":"string","id":1},"rowRestriction":{"type":"string","id":2},"arrowSerializationOptions":{"type":"ArrowSerializationOptions","id":3,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"avroSerializationOptions":{"type":"AvroSerializationOptions","id":4,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"samplePercentage":{"type":"double","id":5,"options":{"(google.api.field_behavior)":"OPTIONAL","proto3_optional":true}},"responseCompressionCodec":{"type":"ResponseCompressionCodec","id":6,"options":{"(google.api.field_behavior)":"OPTIONAL","proto3_optional":true}}},"nested":{"ResponseCompressionCodec":{"values":{"RESPONSE_COMPRESSION_CODEC_UNSPECIFIED":0,"RESPONSE_COMPRESSION_CODEC_LZ4":2}}}}}},"ReadStream":{"options":{"(google.api.resource).type":"bigquerystorage.googleapis.com/ReadStream","(google.api.resource).pattern":"projects/{project}/locations/{location}/sessions/{session}/streams/{stream}"},"fields":{"name":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}}}},"WriteStreamView":{"values":{"WRITE_STREAM_VIEW_UNSPECIFIED":0,"BASIC":1,"FULL":2}},"WriteStream":{"options":{"(google.api.resource).type":"bigquerystorage.googleapis.com/WriteStream","(google.api.resource).pattern":"projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}"},"fields":{"name":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"type":{"type":"Type","id":2,"options":{"(google.api.field_behavior)":"IMMUTABLE"}},"createTime":{"type":"google.protobuf.Timestamp","id":3,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"commitTime":{"type":"google.protobuf.Timestamp","id":4,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"tableSchema":{"type":"TableSchema","id":5,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}},"writeMode":{"type":"WriteMode","id":7,"options":{"(google.api.field_behavior)":"IMMUTABLE"}},"location":{"type":"string","id":8,"options":{"(google.api.field_behavior)":"OUTPUT_ONLY"}}},"nested":{"Type":{"values":{"TYPE_UNSPECIFIED":0,"COMMITTED":1,"PENDING":2,"BUFFERED":3}},"WriteMode":{"values":{"WRITE_MODE_UNSPECIFIED":0,"INSERT":1}}}},"TableSchema":{"fields":{"fields":{"rule":"repeated","type":"TableFieldSchema","id":1}}},"TableFieldSchema":{"fields":{"name":{"type":"string","id":1,"options":{"(google.api.field_behavior)":"REQUIRED"}},"type":{"type":"Type","id":2,"options":{"(google.api.field_behavior)":"REQUIRED"}},"mode":{"type":"Mode","id":3,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"fields":{"rule":"repeated","type":"TableFieldSchema","id":4,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"description":{"type":"string","id":6,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"maxLength":{"type":"int64","id":7,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"precision":{"type":"int64","id":8,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"scale":{"type":"int64","id":9,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"defaultValueExpression":{"type":"string","id":10,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"timestampPrecision":{"type":"google.protobuf.Int64Value","id":27,"options":{"(google.api.field_behavior)":"OPTIONAL"}},"rangeElementType":{"type":"FieldElementType","id":11,"options":{"(google.api.field_behavior)":"OPTIONAL"}}},"nested":{"Type":{"values":{"TYPE_UNSPECIFIED":0,"STRING":1,"INT64":2,"DOUBLE":3,"STRUCT":4,"BYTES":5,"BOOL":6,"TIMESTAMP":7,"DATE":8,"TIME":9,"DATETIME":10,"GEOGRAPHY":11,"NUMERIC":12,"BIGNUMERIC":13,"INTERVAL":14,"JSON":15,"RANGE":16}},"Mode":{"values":{"MODE_UNSPECIFIED":0,"NULLABLE":1,"REQUIRED":2,"REPEATED":3}},"FieldElementType":{"fields":{"type":{"type":"Type","id":1,"options":{"(google.api.field_behavior)":"REQUIRED"}}}}}}}}}}}}}},"protobuf":{"options":{"go_package":"google.golang.org/protobuf/types/descriptorpb","java_package":"com.google.protobuf","java_outer_classname":"DescriptorProtos","csharp_namespace":"Google.Protobuf.Reflection","objc_class_prefix":"GPB","cc_enable_arenas":true,"optimize_for":"SPEED"},"nested":{"FileDescriptorSet":{"edition":"proto2","fields":{"file":{"rule":"repeated","type":"FileDescriptorProto","id":1}},"extensions":[[536e6,536e6]]},"Edition":{"edition":"proto2","values":{"EDITION_UNKNOWN":0,"EDITION_LEGACY":900,"EDITION_PROTO2":998,"EDITION_PROTO3":999,"EDITION_2023":1e3,"EDITION_2024":1001,"EDITION_1_TEST_ONLY":1,"EDITION_2_TEST_ONLY":2,"EDITION_99997_TEST_ONLY":99997,"EDITION_99998_TEST_ONLY":99998,"EDITION_99999_TEST_ONLY":99999,"EDITION_MAX":2147483647}},"FileDescriptorProto":{"edition":"proto2","fields":{"name":{"type":"string","id":1},"package":{"type":"string","id":2},"dependency":{"rule":"repeated","type":"string","id":3},"publicDependency":{"rule":"repeated","type":"int32","id":10},"weakDependency":{"rule":"repeated","type":"int32","id":11},"optionDependency":{"rule":"repeated","type":"string","id":15},"messageType":{"rule":"repeated","type":"DescriptorProto","id":4},"enumType":{"rule":"repeated","type":"EnumDescriptorProto","id":5},"service":{"rule":"repeated","type":"ServiceDescriptorProto","id":6},"extension":{"rule":"repeated","type":"FieldDescriptorProto","id":7},"options":{"type":"FileOptions","id":8},"sourceCodeInfo":{"type":"SourceCodeInfo","id":9},"syntax":{"type":"string","id":12},"edition":{"type":"Edition","id":14}}},"DescriptorProto":{"edition":"proto2","fields":{"name":{"type":"string","id":1},"field":{"rule":"repeated","type":"FieldDescriptorProto","id":2},"extension":{"rule":"repeated","type":"FieldDescriptorProto","id":6},"nestedType":{"rule":"repeated","type":"DescriptorProto","id":3},"enumType":{"rule":"repeated","type":"EnumDescriptorProto","id":4},"extensionRange":{"rule":"repeated","type":"ExtensionRange","id":5},"oneofDecl":{"rule":"repeated","type":"OneofDescriptorProto","id":8},"options":{"type":"MessageOptions","id":7},"reservedRange":{"rule":"repeated","type":"ReservedRange","id":9},"reservedName":{"rule":"repeated","type":"string","id":10},"visibility":{"type":"SymbolVisibility","id":11}},"nested":{"ExtensionRange":{"fields":{"start":{"type":"int32","id":1},"end":{"type":"int32","id":2},"options":{"type":"ExtensionRangeOptions","id":3}}},"ReservedRange":{"fields":{"start":{"type":"int32","id":1},"end":{"type":"int32","id":2}}}}},"ExtensionRangeOptions":{"edition":"proto2","fields":{"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999},"declaration":{"rule":"repeated","type":"Declaration","id":2,"options":{"retention":"RETENTION_SOURCE"}},"features":{"type":"FeatureSet","id":50},"verification":{"type":"VerificationState","id":3,"options":{"default":"UNVERIFIED","retention":"RETENTION_SOURCE"}}},"extensions":[[1e3,536870911]],"nested":{"Declaration":{"fields":{"number":{"type":"int32","id":1},"fullName":{"type":"string","id":2},"type":{"type":"string","id":3},"reserved":{"type":"bool","id":5},"repeated":{"type":"bool","id":6}},"reserved":[[4,4]]},"VerificationState":{"values":{"DECLARATION":0,"UNVERIFIED":1}}}},"FieldDescriptorProto":{"edition":"proto2","fields":{"name":{"type":"string","id":1},"number":{"type":"int32","id":3},"label":{"type":"Label","id":4},"type":{"type":"Type","id":5},"typeName":{"type":"string","id":6},"extendee":{"type":"string","id":2},"defaultValue":{"type":"string","id":7},"oneofIndex":{"type":"int32","id":9},"jsonName":{"type":"string","id":10},"options":{"type":"FieldOptions","id":8},"proto3Optional":{"type":"bool","id":17}},"nested":{"Type":{"values":{"TYPE_DOUBLE":1,"TYPE_FLOAT":2,"TYPE_INT64":3,"TYPE_UINT64":4,"TYPE_INT32":5,"TYPE_FIXED64":6,"TYPE_FIXED32":7,"TYPE_BOOL":8,"TYPE_STRING":9,"TYPE_GROUP":10,"TYPE_MESSAGE":11,"TYPE_BYTES":12,"TYPE_UINT32":13,"TYPE_ENUM":14,"TYPE_SFIXED32":15,"TYPE_SFIXED64":16,"TYPE_SINT32":17,"TYPE_SINT64":18}},"Label":{"values":{"LABEL_OPTIONAL":1,"LABEL_REPEATED":3,"LABEL_REQUIRED":2}}}},"OneofDescriptorProto":{"edition":"proto2","fields":{"name":{"type":"string","id":1},"options":{"type":"OneofOptions","id":2}}},"EnumDescriptorProto":{"edition":"proto2","fields":{"name":{"type":"string","id":1},"value":{"rule":"repeated","type":"EnumValueDescriptorProto","id":2},"options":{"type":"EnumOptions","id":3},"reservedRange":{"rule":"repeated","type":"EnumReservedRange","id":4},"reservedName":{"rule":"repeated","type":"string","id":5},"visibility":{"type":"SymbolVisibility","id":6}},"nested":{"EnumReservedRange":{"fields":{"start":{"type":"int32","id":1},"end":{"type":"int32","id":2}}}}},"EnumValueDescriptorProto":{"edition":"proto2","fields":{"name":{"type":"string","id":1},"number":{"type":"int32","id":2},"options":{"type":"EnumValueOptions","id":3}}},"ServiceDescriptorProto":{"edition":"proto2","fields":{"name":{"type":"string","id":1},"method":{"rule":"repeated","type":"MethodDescriptorProto","id":2},"options":{"type":"ServiceOptions","id":3}},"reserved":[[4,4],"stream"]},"MethodDescriptorProto":{"edition":"proto2","fields":{"name":{"type":"string","id":1},"inputType":{"type":"string","id":2},"outputType":{"type":"string","id":3},"options":{"type":"MethodOptions","id":4},"clientStreaming":{"type":"bool","id":5,"options":{"default":false}},"serverStreaming":{"type":"bool","id":6,"options":{"default":false}}}},"FileOptions":{"edition":"proto2","fields":{"javaPackage":{"type":"string","id":1},"javaOuterClassname":{"type":"string","id":8},"javaMultipleFiles":{"type":"bool","id":10,"options":{"default":false}},"javaGenerateEqualsAndHash":{"type":"bool","id":20,"options":{"deprecated":true}},"javaStringCheckUtf8":{"type":"bool","id":27,"options":{"default":false}},"optimizeFor":{"type":"OptimizeMode","id":9,"options":{"default":"SPEED"}},"goPackage":{"type":"string","id":11},"ccGenericServices":{"type":"bool","id":16,"options":{"default":false}},"javaGenericServices":{"type":"bool","id":17,"options":{"default":false}},"pyGenericServices":{"type":"bool","id":18,"options":{"default":false}},"deprecated":{"type":"bool","id":23,"options":{"default":false}},"ccEnableArenas":{"type":"bool","id":31,"options":{"default":true}},"objcClassPrefix":{"type":"string","id":36},"csharpNamespace":{"type":"string","id":37},"swiftPrefix":{"type":"string","id":39},"phpClassPrefix":{"type":"string","id":40},"phpNamespace":{"type":"string","id":41},"phpMetadataNamespace":{"type":"string","id":44},"rubyPackage":{"type":"string","id":45},"features":{"type":"FeatureSet","id":50},"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999}},"extensions":[[1e3,536870911]],"reserved":[[42,42],"php_generic_services",[38,38]],"nested":{"OptimizeMode":{"values":{"SPEED":1,"CODE_SIZE":2,"LITE_RUNTIME":3}}}},"MessageOptions":{"edition":"proto2","fields":{"messageSetWireFormat":{"type":"bool","id":1,"options":{"default":false}},"noStandardDescriptorAccessor":{"type":"bool","id":2,"options":{"default":false}},"deprecated":{"type":"bool","id":3,"options":{"default":false}},"mapEntry":{"type":"bool","id":7},"deprecatedLegacyJsonFieldConflicts":{"type":"bool","id":11,"options":{"deprecated":true}},"features":{"type":"FeatureSet","id":12},"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999}},"extensions":[[1e3,536870911]],"reserved":[[4,4],[5,5],[6,6],[8,8],[9,9]]},"FieldOptions":{"edition":"proto2","fields":{"ctype":{"type":"CType","id":1,"options":{"default":"STRING"}},"packed":{"type":"bool","id":2},"jstype":{"type":"JSType","id":6,"options":{"default":"JS_NORMAL"}},"lazy":{"type":"bool","id":5,"options":{"default":false}},"unverifiedLazy":{"type":"bool","id":15,"options":{"default":false}},"deprecated":{"type":"bool","id":3,"options":{"default":false}},"weak":{"type":"bool","id":10,"options":{"default":false,"deprecated":true}},"debugRedact":{"type":"bool","id":16,"options":{"default":false}},"retention":{"type":"OptionRetention","id":17},"targets":{"rule":"repeated","type":"OptionTargetType","id":19},"editionDefaults":{"rule":"repeated","type":"EditionDefault","id":20},"features":{"type":"FeatureSet","id":21},"featureSupport":{"type":"FeatureSupport","id":22},"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999}},"extensions":[[1e3,536870911]],"reserved":[[4,4],[18,18]],"nested":{"CType":{"values":{"STRING":0,"CORD":1,"STRING_PIECE":2}},"JSType":{"values":{"JS_NORMAL":0,"JS_STRING":1,"JS_NUMBER":2}},"OptionRetention":{"values":{"RETENTION_UNKNOWN":0,"RETENTION_RUNTIME":1,"RETENTION_SOURCE":2}},"OptionTargetType":{"values":{"TARGET_TYPE_UNKNOWN":0,"TARGET_TYPE_FILE":1,"TARGET_TYPE_EXTENSION_RANGE":2,"TARGET_TYPE_MESSAGE":3,"TARGET_TYPE_FIELD":4,"TARGET_TYPE_ONEOF":5,"TARGET_TYPE_ENUM":6,"TARGET_TYPE_ENUM_ENTRY":7,"TARGET_TYPE_SERVICE":8,"TARGET_TYPE_METHOD":9}},"EditionDefault":{"fields":{"edition":{"type":"Edition","id":3},"value":{"type":"string","id":2}}},"FeatureSupport":{"fields":{"editionIntroduced":{"type":"Edition","id":1},"editionDeprecated":{"type":"Edition","id":2},"deprecationWarning":{"type":"string","id":3},"editionRemoved":{"type":"Edition","id":4}}}}},"OneofOptions":{"edition":"proto2","fields":{"features":{"type":"FeatureSet","id":1},"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999}},"extensions":[[1e3,536870911]]},"EnumOptions":{"edition":"proto2","fields":{"allowAlias":{"type":"bool","id":2},"deprecated":{"type":"bool","id":3,"options":{"default":false}},"deprecatedLegacyJsonFieldConflicts":{"type":"bool","id":6,"options":{"deprecated":true}},"features":{"type":"FeatureSet","id":7},"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999}},"extensions":[[1e3,536870911]],"reserved":[[5,5]]},"EnumValueOptions":{"edition":"proto2","fields":{"deprecated":{"type":"bool","id":1,"options":{"default":false}},"features":{"type":"FeatureSet","id":2},"debugRedact":{"type":"bool","id":3,"options":{"default":false}},"featureSupport":{"type":"FieldOptions.FeatureSupport","id":4},"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999}},"extensions":[[1e3,536870911]]},"ServiceOptions":{"edition":"proto2","fields":{"features":{"type":"FeatureSet","id":34},"deprecated":{"type":"bool","id":33,"options":{"default":false}},"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999}},"extensions":[[1e3,536870911]]},"MethodOptions":{"edition":"proto2","fields":{"deprecated":{"type":"bool","id":33,"options":{"default":false}},"idempotencyLevel":{"type":"IdempotencyLevel","id":34,"options":{"default":"IDEMPOTENCY_UNKNOWN"}},"features":{"type":"FeatureSet","id":35},"uninterpretedOption":{"rule":"repeated","type":"UninterpretedOption","id":999}},"extensions":[[1e3,536870911]],"nested":{"IdempotencyLevel":{"values":{"IDEMPOTENCY_UNKNOWN":0,"NO_SIDE_EFFECTS":1,"IDEMPOTENT":2}}}},"UninterpretedOption":{"edition":"proto2","fields":{"name":{"rule":"repeated","type":"NamePart","id":2},"identifierValue":{"type":"string","id":3},"positiveIntValue":{"type":"uint64","id":4},"negativeIntValue":{"type":"int64","id":5},"doubleValue":{"type":"double","id":6},"stringValue":{"type":"bytes","id":7},"aggregateValue":{"type":"string","id":8}},"nested":{"NamePart":{"fields":{"namePart":{"rule":"required","type":"string","id":1},"isExtension":{"rule":"required","type":"bool","id":2}}}}},"FeatureSet":{"edition":"proto2","fields":{"fieldPresence":{"type":"FieldPresence","id":1,"options":{"retention":"RETENTION_RUNTIME","targets":"TARGET_TYPE_FILE","feature_support.edition_introduced":"EDITION_2023","edition_defaults.edition":"EDITION_2023","edition_defaults.value":"EXPLICIT"}},"enumType":{"type":"EnumType","id":2,"options":{"retention":"RETENTION_RUNTIME","targets":"TARGET_TYPE_FILE","feature_support.edition_introduced":"EDITION_2023","edition_defaults.edition":"EDITION_PROTO3","edition_defaults.value":"OPEN"}},"repeatedFieldEncoding":{"type":"RepeatedFieldEncoding","id":3,"options":{"retention":"RETENTION_RUNTIME","targets":"TARGET_TYPE_FILE","feature_support.edition_introduced":"EDITION_2023","edition_defaults.edition":"EDITION_PROTO3","edition_defaults.value":"PACKED"}},"utf8Validation":{"type":"Utf8Validation","id":4,"options":{"retention":"RETENTION_RUNTIME","targets":"TARGET_TYPE_FILE","feature_support.edition_introduced":"EDITION_2023","edition_defaults.edition":"EDITION_PROTO3","edition_defaults.value":"VERIFY"}},"messageEncoding":{"type":"MessageEncoding","id":5,"options":{"retention":"RETENTION_RUNTIME","targets":"TARGET_TYPE_FILE","feature_support.edition_introduced":"EDITION_2023","edition_defaults.edition":"EDITION_LEGACY","edition_defaults.value":"LENGTH_PREFIXED"}},"jsonFormat":{"type":"JsonFormat","id":6,"options":{"retention":"RETENTION_RUNTIME","targets":"TARGET_TYPE_FILE","feature_support.edition_introduced":"EDITION_2023","edition_defaults.edition":"EDITION_PROTO3","edition_defaults.value":"ALLOW"}},"enforceNamingStyle":{"type":"EnforceNamingStyle","id":7,"options":{"retention":"RETENTION_SOURCE","targets":"TARGET_TYPE_METHOD","feature_support.edition_introduced":"EDITION_2024","edition_defaults.edition":"EDITION_2024","edition_defaults.value":"STYLE2024"}},"defaultSymbolVisibility":{"type":"VisibilityFeature.DefaultSymbolVisibility","id":8,"options":{"retention":"RETENTION_SOURCE","targets":"TARGET_TYPE_FILE","feature_support.edition_introduced":"EDITION_2024","edition_defaults.edition":"EDITION_2024","edition_defaults.value":"EXPORT_TOP_LEVEL"}}},"extensions":[[1e3,9994],[9995,9999],[1e4,1e4]],"reserved":[[999,999]],"nested":{"FieldPresence":{"values":{"FIELD_PRESENCE_UNKNOWN":0,"EXPLICIT":1,"IMPLICIT":2,"LEGACY_REQUIRED":3}},"EnumType":{"values":{"ENUM_TYPE_UNKNOWN":0,"OPEN":1,"CLOSED":2}},"RepeatedFieldEncoding":{"values":{"REPEATED_FIELD_ENCODING_UNKNOWN":0,"PACKED":1,"EXPANDED":2}},"Utf8Validation":{"values":{"UTF8_VALIDATION_UNKNOWN":0,"VERIFY":2,"NONE":3},"reserved":[[1,1]]},"MessageEncoding":{"values":{"MESSAGE_ENCODING_UNKNOWN":0,"LENGTH_PREFIXED":1,"DELIMITED":2}},"JsonFormat":{"values":{"JSON_FORMAT_UNKNOWN":0,"ALLOW":1,"LEGACY_BEST_EFFORT":2}},"EnforceNamingStyle":{"values":{"ENFORCE_NAMING_STYLE_UNKNOWN":0,"STYLE2024":1,"STYLE_LEGACY":2}},"VisibilityFeature":{"fields":{},"reserved":[[1,536870911]],"nested":{"DefaultSymbolVisibility":{"values":{"DEFAULT_SYMBOL_VISIBILITY_UNKNOWN":0,"EXPORT_ALL":1,"EXPORT_TOP_LEVEL":2,"LOCAL_ALL":3,"STRICT":4}}}}}},"FeatureSetDefaults":{"edition":"proto2","fields":{"defaults":{"rule":"repeated","type":"FeatureSetEditionDefault","id":1},"minimumEdition":{"type":"Edition","id":4},"maximumEdition":{"type":"Edition","id":5}},"nested":{"FeatureSetEditionDefault":{"fields":{"edition":{"type":"Edition","id":3},"overridableFeatures":{"type":"FeatureSet","id":4},"fixedFeatures":{"type":"FeatureSet","id":5}},"reserved":[[1,1],[2,2],"features"]}}},"SourceCodeInfo":{"edition":"proto2","fields":{"location":{"rule":"repeated","type":"Location","id":1}},"extensions":[[536e6,536e6]],"nested":{"Location":{"fields":{"path":{"rule":"repeated","type":"int32","id":1,"options":{"packed":true}},"span":{"rule":"repeated","type":"int32","id":2,"options":{"packed":true}},"leadingComments":{"type":"string","id":3},"trailingComments":{"type":"string","id":4},"leadingDetachedComments":{"rule":"repeated","type":"string","id":6}}}}},"GeneratedCodeInfo":{"edition":"proto2","fields":{"annotation":{"rule":"repeated","type":"Annotation","id":1}},"nested":{"Annotation":{"fields":{"path":{"rule":"repeated","type":"int32","id":1,"options":{"packed":true}},"sourceFile":{"type":"string","id":2},"begin":{"type":"int32","id":3},"end":{"type":"int32","id":4},"semantic":{"type":"Semantic","id":5}},"nested":{"Semantic":{"values":{"NONE":0,"SET":1,"ALIAS":2}}}}}},"SymbolVisibility":{"edition":"proto2","values":{"VISIBILITY_UNSET":0,"VISIBILITY_LOCAL":1,"VISIBILITY_EXPORT":2}},"Duration":{"fields":{"seconds":{"type":"int64","id":1},"nanos":{"type":"int32","id":2}}},"DoubleValue":{"fields":{"value":{"type":"double","id":1}}},"FloatValue":{"fields":{"value":{"type":"float","id":1}}},"Int64Value":{"fields":{"value":{"type":"int64","id":1}}},"UInt64Value":{"fields":{"value":{"type":"uint64","id":1}}},"Int32Value":{"fields":{"value":{"type":"int32","id":1}}},"UInt32Value":{"fields":{"value":{"type":"uint32","id":1}}},"BoolValue":{"fields":{"value":{"type":"bool","id":1}}},"StringValue":{"fields":{"value":{"type":"string","id":1}}},"BytesValue":{"fields":{"value":{"type":"bytes","id":1}}},"Timestamp":{"fields":{"seconds":{"type":"int64","id":1},"nanos":{"type":"int32","id":2}}},"Any":{"fields":{"type_url":{"type":"string","id":1},"value":{"type":"bytes","id":2}}}}},"api":{"options":{"go_package":"google.golang.org/genproto/googleapis/api/annotations;annotations","java_multiple_files":true,"java_outer_classname":"ResourceProto","java_package":"com.google.api","objc_class_prefix":"GAPI"},"nested":{"http":{"type":"HttpRule","id":72295728,"extend":"google.protobuf.MethodOptions"},"Http":{"fields":{"rules":{"rule":"repeated","type":"HttpRule","id":1},"fullyDecodeReservedExpansion":{"type":"bool","id":2}}},"HttpRule":{"oneofs":{"pattern":{"oneof":["get","put","post","delete","patch","custom"]}},"fields":{"selector":{"type":"string","id":1},"get":{"type":"string","id":2},"put":{"type":"string","id":3},"post":{"type":"string","id":4},"delete":{"type":"string","id":5},"patch":{"type":"string","id":6},"custom":{"type":"CustomHttpPattern","id":8},"body":{"type":"string","id":7},"responseBody":{"type":"string","id":12},"additionalBindings":{"rule":"repeated","type":"HttpRule","id":11}}},"CustomHttpPattern":{"fields":{"kind":{"type":"string","id":1},"path":{"type":"string","id":2}}},"methodSignature":{"rule":"repeated","type":"string","id":1051,"extend":"google.protobuf.MethodOptions"},"defaultHost":{"type":"string","id":1049,"extend":"google.protobuf.ServiceOptions"},"oauthScopes":{"type":"string","id":1050,"extend":"google.protobuf.ServiceOptions"},"apiVersion":{"type":"string","id":525000001,"extend":"google.protobuf.ServiceOptions"},"CommonLanguageSettings":{"fields":{"referenceDocsUri":{"type":"string","id":1,"options":{"deprecated":true}},"destinations":{"rule":"repeated","type":"ClientLibraryDestination","id":2},"selectiveGapicGeneration":{"type":"SelectiveGapicGeneration","id":3}}},"ClientLibrarySettings":{"fields":{"version":{"type":"string","id":1},"launchStage":{"type":"LaunchStage","id":2},"restNumericEnums":{"type":"bool","id":3},"javaSettings":{"type":"JavaSettings","id":21},"cppSettings":{"type":"CppSettings","id":22},"phpSettings":{"type":"PhpSettings","id":23},"pythonSettings":{"type":"PythonSettings","id":24},"nodeSettings":{"type":"NodeSettings","id":25},"dotnetSettings":{"type":"DotnetSettings","id":26},"rubySettings":{"type":"RubySettings","id":27},"goSettings":{"type":"GoSettings","id":28}}},"Publishing":{"fields":{"methodSettings":{"rule":"repeated","type":"MethodSettings","id":2},"newIssueUri":{"type":"string","id":101},"documentationUri":{"type":"string","id":102},"apiShortName":{"type":"string","id":103},"githubLabel":{"type":"string","id":104},"codeownerGithubTeams":{"rule":"repeated","type":"string","id":105},"docTagPrefix":{"type":"string","id":106},"organization":{"type":"ClientLibraryOrganization","id":107},"librarySettings":{"rule":"repeated","type":"ClientLibrarySettings","id":109},"protoReferenceDocumentationUri":{"type":"string","id":110},"restReferenceDocumentationUri":{"type":"string","id":111}}},"JavaSettings":{"fields":{"libraryPackage":{"type":"string","id":1},"serviceClassNames":{"keyType":"string","type":"string","id":2},"common":{"type":"CommonLanguageSettings","id":3}}},"CppSettings":{"fields":{"common":{"type":"CommonLanguageSettings","id":1}}},"PhpSettings":{"fields":{"common":{"type":"CommonLanguageSettings","id":1}}},"PythonSettings":{"fields":{"common":{"type":"CommonLanguageSettings","id":1},"experimentalFeatures":{"type":"ExperimentalFeatures","id":2}},"nested":{"ExperimentalFeatures":{"fields":{"restAsyncIoEnabled":{"type":"bool","id":1},"protobufPythonicTypesEnabled":{"type":"bool","id":2},"unversionedPackageDisabled":{"type":"bool","id":3}}}}},"NodeSettings":{"fields":{"common":{"type":"CommonLanguageSettings","id":1}}},"DotnetSettings":{"fields":{"common":{"type":"CommonLanguageSettings","id":1},"renamedServices":{"keyType":"string","type":"string","id":2},"renamedResources":{"keyType":"string","type":"string","id":3},"ignoredResources":{"rule":"repeated","type":"string","id":4},"forcedNamespaceAliases":{"rule":"repeated","type":"string","id":5},"handwrittenSignatures":{"rule":"repeated","type":"string","id":6}}},"RubySettings":{"fields":{"common":{"type":"CommonLanguageSettings","id":1}}},"GoSettings":{"fields":{"common":{"type":"CommonLanguageSettings","id":1},"renamedServices":{"keyType":"string","type":"string","id":2}}},"MethodSettings":{"fields":{"selector":{"type":"string","id":1},"longRunning":{"type":"LongRunning","id":2},"autoPopulatedFields":{"rule":"repeated","type":"string","id":3}},"nested":{"LongRunning":{"fields":{"initialPollDelay":{"type":"google.protobuf.Duration","id":1},"pollDelayMultiplier":{"type":"float","id":2},"maxPollDelay":{"type":"google.protobuf.Duration","id":3},"totalPollTimeout":{"type":"google.protobuf.Duration","id":4}}}}},"ClientLibraryOrganization":{"values":{"CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED":0,"CLOUD":1,"ADS":2,"PHOTOS":3,"STREET_VIEW":4,"SHOPPING":5,"GEO":6,"GENERATIVE_AI":7}},"ClientLibraryDestination":{"values":{"CLIENT_LIBRARY_DESTINATION_UNSPECIFIED":0,"GITHUB":10,"PACKAGE_MANAGER":20}},"SelectiveGapicGeneration":{"fields":{"methods":{"rule":"repeated","type":"string","id":1},"generateOmittedAsInternal":{"type":"bool","id":2}}},"LaunchStage":{"values":{"LAUNCH_STAGE_UNSPECIFIED":0,"UNIMPLEMENTED":6,"PRELAUNCH":7,"EARLY_ACCESS":1,"ALPHA":2,"BETA":3,"GA":4,"DEPRECATED":5}},"fieldBehavior":{"rule":"repeated","type":"google.api.FieldBehavior","id":1052,"extend":"google.protobuf.FieldOptions","options":{"packed":false}},"FieldBehavior":{"values":{"FIELD_BEHAVIOR_UNSPECIFIED":0,"OPTIONAL":1,"REQUIRED":2,"OUTPUT_ONLY":3,"INPUT_ONLY":4,"IMMUTABLE":5,"UNORDERED_LIST":6,"NON_EMPTY_DEFAULT":7,"IDENTIFIER":8}},"resourceReference":{"type":"google.api.ResourceReference","id":1055,"extend":"google.protobuf.FieldOptions"},"resourceDefinition":{"rule":"repeated","type":"google.api.ResourceDescriptor","id":1053,"extend":"google.protobuf.FileOptions"},"resource":{"type":"google.api.ResourceDescriptor","id":1053,"extend":"google.protobuf.MessageOptions"},"ResourceDescriptor":{"fields":{"type":{"type":"string","id":1},"pattern":{"rule":"repeated","type":"string","id":2},"nameField":{"type":"string","id":3},"history":{"type":"History","id":4},"plural":{"type":"string","id":5},"singular":{"type":"string","id":6},"style":{"rule":"repeated","type":"Style","id":10}},"nested":{"History":{"values":{"HISTORY_UNSPECIFIED":0,"ORIGINALLY_SINGLE_PATTERN":1,"FUTURE_MULTI_PATTERN":2}},"Style":{"values":{"STYLE_UNSPECIFIED":0,"DECLARATIVE_FRIENDLY":1}}}},"ResourceReference":{"fields":{"type":{"type":"string","id":1},"childType":{"type":"string","id":2}}}}},"rpc":{"options":{"cc_enable_arenas":true,"go_package":"google.golang.org/genproto/googleapis/rpc/status;status","java_multiple_files":true,"java_outer_classname":"StatusProto","java_package":"com.google.rpc","objc_class_prefix":"RPC"},"nested":{"Status":{"fields":{"code":{"type":"int32","id":1},"message":{"type":"string","id":2},"details":{"rule":"repeated","type":"google.protobuf.Any","id":3}}}}}}}}}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import * as v1 from './v1';
|
|
2
|
+
declare const BigQueryReadClient: typeof v1.BigQueryReadClient;
|
|
3
|
+
type BigQueryReadClient = v1.BigQueryReadClient;
|
|
4
|
+
declare const BigQueryWriteClient: typeof v1.BigQueryWriteClient;
|
|
5
|
+
type BigQueryWriteClient = v1.BigQueryWriteClient;
|
|
6
|
+
export { v1, BigQueryReadClient, BigQueryWriteClient };
|
|
7
|
+
declare const _default: {
|
|
8
|
+
v1: typeof v1;
|
|
9
|
+
BigQueryReadClient: typeof v1.BigQueryReadClient;
|
|
10
|
+
BigQueryWriteClient: typeof v1.BigQueryWriteClient;
|
|
11
|
+
};
|
|
12
|
+
export default _default;
|
|
13
|
+
import * as protos from '../protos/protos';
|
|
14
|
+
export { protos };
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright 2026 Google LLC
|
|
3
|
+
//
|
|
4
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
// you may not use this file except in compliance with the License.
|
|
6
|
+
// You may obtain a copy of the License at
|
|
7
|
+
//
|
|
8
|
+
// https://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
//
|
|
10
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
// See the License for the specific language governing permissions and
|
|
14
|
+
// limitations under the License.
|
|
15
|
+
//
|
|
16
|
+
// ** This file is automatically generated by synthtool. **
|
|
17
|
+
// ** https://github.com/googleapis/synthtool **
|
|
18
|
+
// ** All changes to this file may be overwritten. **
|
|
19
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
+
exports.protos = exports.BigQueryWriteClient = exports.BigQueryReadClient = exports.v1 = void 0;
|
|
21
|
+
const v1 = require("./v1");
|
|
22
|
+
exports.v1 = v1;
|
|
23
|
+
const BigQueryReadClient = v1.BigQueryReadClient;
|
|
24
|
+
exports.BigQueryReadClient = BigQueryReadClient;
|
|
25
|
+
const BigQueryWriteClient = v1.BigQueryWriteClient;
|
|
26
|
+
exports.BigQueryWriteClient = BigQueryWriteClient;
|
|
27
|
+
exports.default = { v1, BigQueryReadClient, BigQueryWriteClient };
|
|
28
|
+
const protos = require("../protos/protos");
|
|
29
|
+
exports.protos = protos;
|
|
30
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,2DAA2D;AAC3D,gDAAgD;AAChD,qDAAqD;;;AAErD,2BAA2B;AAMnB,gBAAE;AAJV,MAAM,kBAAkB,GAAG,EAAE,CAAC,kBAAkB,CAAC;AAIrC,gDAAkB;AAF9B,MAAM,mBAAmB,GAAG,EAAE,CAAC,mBAAmB,CAAC;AAEnB,kDAAmB;AACnD,kBAAe,EAAC,EAAE,EAAE,kBAAkB,EAAE,mBAAmB,EAAC,CAAC;AAC7D,2CAA2C;AACnC,wBAAM"}
|
|
@@ -0,0 +1,424 @@
|
|
|
1
|
+
import type * as gax from 'google-gax';
|
|
2
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
|
|
3
|
+
import * as protos from '../../protos/protos';
|
|
4
|
+
/**
|
|
5
|
+
* BigQuery Read API.
|
|
6
|
+
*
|
|
7
|
+
* The Read API can be used to read data from BigQuery.
|
|
8
|
+
* @class
|
|
9
|
+
* @memberof v1
|
|
10
|
+
*/
|
|
11
|
+
export declare class BigQueryReadClient {
|
|
12
|
+
private _terminated;
|
|
13
|
+
private _opts;
|
|
14
|
+
private _providedCustomServicePath;
|
|
15
|
+
private _gaxModule;
|
|
16
|
+
private _gaxGrpc;
|
|
17
|
+
private _protos;
|
|
18
|
+
private _defaults;
|
|
19
|
+
private _universeDomain;
|
|
20
|
+
private _servicePath;
|
|
21
|
+
private _log;
|
|
22
|
+
auth: gax.GoogleAuth;
|
|
23
|
+
descriptors: Descriptors;
|
|
24
|
+
warn: (code: string, message: string, warnType?: string) => void;
|
|
25
|
+
innerApiCalls: {
|
|
26
|
+
[name: string]: Function;
|
|
27
|
+
};
|
|
28
|
+
pathTemplates: {
|
|
29
|
+
[name: string]: gax.PathTemplate;
|
|
30
|
+
};
|
|
31
|
+
bigQueryReadStub?: Promise<{
|
|
32
|
+
[name: string]: Function;
|
|
33
|
+
}>;
|
|
34
|
+
/**
|
|
35
|
+
* Construct an instance of BigQueryReadClient.
|
|
36
|
+
*
|
|
37
|
+
* @param {object} [options] - The configuration object.
|
|
38
|
+
* The options accepted by the constructor are described in detail
|
|
39
|
+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
|
40
|
+
* The common options are:
|
|
41
|
+
* @param {object} [options.credentials] - Credentials object.
|
|
42
|
+
* @param {string} [options.credentials.client_email]
|
|
43
|
+
* @param {string} [options.credentials.private_key]
|
|
44
|
+
* @param {string} [options.email] - Account email address. Required when
|
|
45
|
+
* using a .pem or .p12 keyFilename.
|
|
46
|
+
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
|
47
|
+
* .p12 key downloaded from the Google Developers Console. If you provide
|
|
48
|
+
* a path to a JSON file, the projectId option below is not necessary.
|
|
49
|
+
* NOTE: .pem and .p12 require you to specify options.email as well.
|
|
50
|
+
* @param {number} [options.port] - The port on which to connect to
|
|
51
|
+
* the remote host.
|
|
52
|
+
* @param {string} [options.projectId] - The project ID from the Google
|
|
53
|
+
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
|
54
|
+
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
|
55
|
+
* app is running in an environment which supports
|
|
56
|
+
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
|
|
57
|
+
* your project ID will be detected automatically.
|
|
58
|
+
* @param {string} [options.apiEndpoint] - The domain name of the
|
|
59
|
+
* API remote host.
|
|
60
|
+
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
61
|
+
* Follows the structure of {@link gapicConfig}.
|
|
62
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
|
63
|
+
* For more information, please check the
|
|
64
|
+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
65
|
+
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
66
|
+
* need to avoid loading the default gRPC version and want to use the fallback
|
|
67
|
+
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
68
|
+
* ```
|
|
69
|
+
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
70
|
+
* const client = new BigQueryReadClient({fallback: true}, gax);
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
|
74
|
+
/**
|
|
75
|
+
* Initialize the client.
|
|
76
|
+
* Performs asynchronous operations (such as authentication) and prepares the client.
|
|
77
|
+
* This function will be called automatically when any class method is called for the
|
|
78
|
+
* first time, but if you need to initialize it before calling an actual method,
|
|
79
|
+
* feel free to call initialize() directly.
|
|
80
|
+
*
|
|
81
|
+
* You can await on this method if you want to make sure the client is initialized.
|
|
82
|
+
*
|
|
83
|
+
* @returns {Promise} A promise that resolves to an authenticated service stub.
|
|
84
|
+
*/
|
|
85
|
+
initialize(): Promise<{
|
|
86
|
+
[name: string]: Function;
|
|
87
|
+
}>;
|
|
88
|
+
/**
|
|
89
|
+
* The DNS address for this API service.
|
|
90
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
|
91
|
+
* @returns {string} The DNS address for this service.
|
|
92
|
+
*/
|
|
93
|
+
static get servicePath(): string;
|
|
94
|
+
/**
|
|
95
|
+
* The DNS address for this API service - same as servicePath.
|
|
96
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
|
97
|
+
* @returns {string} The DNS address for this service.
|
|
98
|
+
*/
|
|
99
|
+
static get apiEndpoint(): string;
|
|
100
|
+
/**
|
|
101
|
+
* The DNS address for this API service.
|
|
102
|
+
* @returns {string} The DNS address for this service.
|
|
103
|
+
*/
|
|
104
|
+
get apiEndpoint(): string;
|
|
105
|
+
get universeDomain(): string;
|
|
106
|
+
/**
|
|
107
|
+
* The port for this API service.
|
|
108
|
+
* @returns {number} The default port for this service.
|
|
109
|
+
*/
|
|
110
|
+
static get port(): number;
|
|
111
|
+
/**
|
|
112
|
+
* The scopes needed to make gRPC calls for every method defined
|
|
113
|
+
* in this service.
|
|
114
|
+
* @returns {string[]} List of default scopes.
|
|
115
|
+
*/
|
|
116
|
+
static get scopes(): string[];
|
|
117
|
+
getProjectId(): Promise<string>;
|
|
118
|
+
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
|
119
|
+
/**
|
|
120
|
+
* Creates a new read session. A read session divides the contents of a
|
|
121
|
+
* BigQuery table into one or more streams, which can then be used to read
|
|
122
|
+
* data from the table. The read session also specifies properties of the
|
|
123
|
+
* data to be read, such as a list of columns or a push-down filter describing
|
|
124
|
+
* the rows to be returned.
|
|
125
|
+
*
|
|
126
|
+
* A particular row can be read by at most one stream. When the caller has
|
|
127
|
+
* reached the end of each stream in the session, then all the data in the
|
|
128
|
+
* table has been read.
|
|
129
|
+
*
|
|
130
|
+
* Data is assigned to each stream such that roughly the same number of
|
|
131
|
+
* rows can be read from each stream. Because the server-side unit for
|
|
132
|
+
* assigning data is collections of rows, the API does not guarantee that
|
|
133
|
+
* each stream will return the same number or rows. Additionally, the
|
|
134
|
+
* limits are enforced based on the number of pre-filtered rows, so some
|
|
135
|
+
* filters can lead to lopsided assignments.
|
|
136
|
+
*
|
|
137
|
+
* Read sessions automatically expire 6 hours after they are created and do
|
|
138
|
+
* not require manual clean-up by the caller.
|
|
139
|
+
*
|
|
140
|
+
* @param {Object} request
|
|
141
|
+
* The request object that will be sent.
|
|
142
|
+
* @param {string} request.parent
|
|
143
|
+
* Required. The request project that owns the session, in the form of
|
|
144
|
+
* `projects/{project_id}`.
|
|
145
|
+
* @param {google.cloud.bigquery.storage.v1.ReadSession} request.readSession
|
|
146
|
+
* Required. Session to be created.
|
|
147
|
+
* @param {number} request.maxStreamCount
|
|
148
|
+
* Max initial number of streams. If unset or zero, the server will
|
|
149
|
+
* provide a value of streams so as to produce reasonable throughput. Must be
|
|
150
|
+
* non-negative. The number of streams may be lower than the requested number,
|
|
151
|
+
* depending on the amount parallelism that is reasonable for the table.
|
|
152
|
+
* There is a default system max limit of 1,000.
|
|
153
|
+
*
|
|
154
|
+
* This must be greater than or equal to preferred_min_stream_count.
|
|
155
|
+
* Typically, clients should either leave this unset to let the system to
|
|
156
|
+
* determine an upper bound OR set this a size for the maximum "units of work"
|
|
157
|
+
* it can gracefully handle.
|
|
158
|
+
* @param {number} request.preferredMinStreamCount
|
|
159
|
+
* The minimum preferred stream count. This parameter can be used to inform
|
|
160
|
+
* the service that there is a desired lower bound on the number of streams.
|
|
161
|
+
* This is typically a target parallelism of the client (e.g. a Spark
|
|
162
|
+
* cluster with N-workers would set this to a low multiple of N to ensure
|
|
163
|
+
* good cluster utilization).
|
|
164
|
+
*
|
|
165
|
+
* The system will make a best effort to provide at least this number of
|
|
166
|
+
* streams, but in some cases might provide less.
|
|
167
|
+
* @param {object} [options]
|
|
168
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
169
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
170
|
+
* The first element of the array is an object representing {@link protos.google.cloud.bigquery.storage.v1.ReadSession|ReadSession}.
|
|
171
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
172
|
+
* for more details and examples.
|
|
173
|
+
* @example <caption>include:samples/generated/v1/big_query_read.create_read_session.js</caption>
|
|
174
|
+
* region_tag:bigquerystorage_v1_generated_BigQueryRead_CreateReadSession_async
|
|
175
|
+
*/
|
|
176
|
+
createReadSession(request?: protos.google.cloud.bigquery.storage.v1.ICreateReadSessionRequest, options?: CallOptions): Promise<[
|
|
177
|
+
protos.google.cloud.bigquery.storage.v1.IReadSession,
|
|
178
|
+
(protos.google.cloud.bigquery.storage.v1.ICreateReadSessionRequest | undefined),
|
|
179
|
+
{} | undefined
|
|
180
|
+
]>;
|
|
181
|
+
createReadSession(request: protos.google.cloud.bigquery.storage.v1.ICreateReadSessionRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.storage.v1.IReadSession, protos.google.cloud.bigquery.storage.v1.ICreateReadSessionRequest | null | undefined, {} | null | undefined>): void;
|
|
182
|
+
createReadSession(request: protos.google.cloud.bigquery.storage.v1.ICreateReadSessionRequest, callback: Callback<protos.google.cloud.bigquery.storage.v1.IReadSession, protos.google.cloud.bigquery.storage.v1.ICreateReadSessionRequest | null | undefined, {} | null | undefined>): void;
|
|
183
|
+
/**
|
|
184
|
+
* Splits a given `ReadStream` into two `ReadStream` objects. These
|
|
185
|
+
* `ReadStream` objects are referred to as the primary and the residual
|
|
186
|
+
* streams of the split. The original `ReadStream` can still be read from in
|
|
187
|
+
* the same manner as before. Both of the returned `ReadStream` objects can
|
|
188
|
+
* also be read from, and the rows returned by both child streams will be
|
|
189
|
+
* the same as the rows read from the original stream.
|
|
190
|
+
*
|
|
191
|
+
* Moreover, the two child streams will be allocated back-to-back in the
|
|
192
|
+
* original `ReadStream`. Concretely, it is guaranteed that for streams
|
|
193
|
+
* original, primary, and residual, that original[0-j] = primary[0-j] and
|
|
194
|
+
* original[j-n] = residual[0-m] once the streams have been read to
|
|
195
|
+
* completion.
|
|
196
|
+
*
|
|
197
|
+
* @param {Object} request
|
|
198
|
+
* The request object that will be sent.
|
|
199
|
+
* @param {string} request.name
|
|
200
|
+
* Required. Name of the stream to split.
|
|
201
|
+
* @param {number} request.fraction
|
|
202
|
+
* A value in the range (0.0, 1.0) that specifies the fractional point at
|
|
203
|
+
* which the original stream should be split. The actual split point is
|
|
204
|
+
* evaluated on pre-filtered rows, so if a filter is provided, then there is
|
|
205
|
+
* no guarantee that the division of the rows between the new child streams
|
|
206
|
+
* will be proportional to this fractional value. Additionally, because the
|
|
207
|
+
* server-side unit for assigning data is collections of rows, this fraction
|
|
208
|
+
* will always map to a data storage boundary on the server side.
|
|
209
|
+
* @param {object} [options]
|
|
210
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
211
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
212
|
+
* The first element of the array is an object representing {@link protos.google.cloud.bigquery.storage.v1.SplitReadStreamResponse|SplitReadStreamResponse}.
|
|
213
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
214
|
+
* for more details and examples.
|
|
215
|
+
* @example <caption>include:samples/generated/v1/big_query_read.split_read_stream.js</caption>
|
|
216
|
+
* region_tag:bigquerystorage_v1_generated_BigQueryRead_SplitReadStream_async
|
|
217
|
+
*/
|
|
218
|
+
splitReadStream(request?: protos.google.cloud.bigquery.storage.v1.ISplitReadStreamRequest, options?: CallOptions): Promise<[
|
|
219
|
+
protos.google.cloud.bigquery.storage.v1.ISplitReadStreamResponse,
|
|
220
|
+
(protos.google.cloud.bigquery.storage.v1.ISplitReadStreamRequest | undefined),
|
|
221
|
+
{} | undefined
|
|
222
|
+
]>;
|
|
223
|
+
splitReadStream(request: protos.google.cloud.bigquery.storage.v1.ISplitReadStreamRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.storage.v1.ISplitReadStreamResponse, protos.google.cloud.bigquery.storage.v1.ISplitReadStreamRequest | null | undefined, {} | null | undefined>): void;
|
|
224
|
+
splitReadStream(request: protos.google.cloud.bigquery.storage.v1.ISplitReadStreamRequest, callback: Callback<protos.google.cloud.bigquery.storage.v1.ISplitReadStreamResponse, protos.google.cloud.bigquery.storage.v1.ISplitReadStreamRequest | null | undefined, {} | null | undefined>): void;
|
|
225
|
+
/**
|
|
226
|
+
* Reads rows from the stream in the format prescribed by the ReadSession.
|
|
227
|
+
* Each response contains one or more table rows, up to a maximum of 128 MB
|
|
228
|
+
* per response; read requests which attempt to read individual rows larger
|
|
229
|
+
* than 128 MB will fail.
|
|
230
|
+
*
|
|
231
|
+
* Each request also returns a set of stream statistics reflecting the current
|
|
232
|
+
* state of the stream.
|
|
233
|
+
*
|
|
234
|
+
* @param {Object} request
|
|
235
|
+
* The request object that will be sent.
|
|
236
|
+
* @param {string} request.readStream
|
|
237
|
+
* Required. Stream to read rows from.
|
|
238
|
+
* @param {number} request.offset
|
|
239
|
+
* The offset requested must be less than the last row read from Read.
|
|
240
|
+
* Requesting a larger offset is undefined. If not specified, start reading
|
|
241
|
+
* from offset zero.
|
|
242
|
+
* @param {object} [options]
|
|
243
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
244
|
+
* @returns {Stream}
|
|
245
|
+
* An object stream which emits {@link protos.google.cloud.bigquery.storage.v1.ReadRowsResponse|ReadRowsResponse} on 'data' event.
|
|
246
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation }
|
|
247
|
+
* for more details and examples.
|
|
248
|
+
* @example <caption>include:samples/generated/v1/big_query_read.read_rows.js</caption>
|
|
249
|
+
* region_tag:bigquerystorage_v1_generated_BigQueryRead_ReadRows_async
|
|
250
|
+
*/
|
|
251
|
+
readRows(request?: protos.google.cloud.bigquery.storage.v1.IReadRowsRequest, options?: CallOptions): gax.CancellableStream;
|
|
252
|
+
/**
|
|
253
|
+
* Return a fully-qualified project resource name string.
|
|
254
|
+
*
|
|
255
|
+
* @param {string} project
|
|
256
|
+
* @returns {string} Resource name string.
|
|
257
|
+
*/
|
|
258
|
+
projectPath(project: string): string;
|
|
259
|
+
/**
|
|
260
|
+
* Parse the project from Project resource.
|
|
261
|
+
*
|
|
262
|
+
* @param {string} projectName
|
|
263
|
+
* A fully-qualified path representing Project resource.
|
|
264
|
+
* @returns {string} A string representing the project.
|
|
265
|
+
*/
|
|
266
|
+
matchProjectFromProjectName(projectName: string): string | number;
|
|
267
|
+
/**
|
|
268
|
+
* Return a fully-qualified readSession resource name string.
|
|
269
|
+
*
|
|
270
|
+
* @param {string} project
|
|
271
|
+
* @param {string} location
|
|
272
|
+
* @param {string} session
|
|
273
|
+
* @returns {string} Resource name string.
|
|
274
|
+
*/
|
|
275
|
+
readSessionPath(project: string, location: string, session: string): string;
|
|
276
|
+
/**
|
|
277
|
+
* Parse the project from ReadSession resource.
|
|
278
|
+
*
|
|
279
|
+
* @param {string} readSessionName
|
|
280
|
+
* A fully-qualified path representing ReadSession resource.
|
|
281
|
+
* @returns {string} A string representing the project.
|
|
282
|
+
*/
|
|
283
|
+
matchProjectFromReadSessionName(readSessionName: string): string | number;
|
|
284
|
+
/**
|
|
285
|
+
* Parse the location from ReadSession resource.
|
|
286
|
+
*
|
|
287
|
+
* @param {string} readSessionName
|
|
288
|
+
* A fully-qualified path representing ReadSession resource.
|
|
289
|
+
* @returns {string} A string representing the location.
|
|
290
|
+
*/
|
|
291
|
+
matchLocationFromReadSessionName(readSessionName: string): string | number;
|
|
292
|
+
/**
|
|
293
|
+
* Parse the session from ReadSession resource.
|
|
294
|
+
*
|
|
295
|
+
* @param {string} readSessionName
|
|
296
|
+
* A fully-qualified path representing ReadSession resource.
|
|
297
|
+
* @returns {string} A string representing the session.
|
|
298
|
+
*/
|
|
299
|
+
matchSessionFromReadSessionName(readSessionName: string): string | number;
|
|
300
|
+
/**
|
|
301
|
+
* Return a fully-qualified readStream resource name string.
|
|
302
|
+
*
|
|
303
|
+
* @param {string} project
|
|
304
|
+
* @param {string} location
|
|
305
|
+
* @param {string} session
|
|
306
|
+
* @param {string} stream
|
|
307
|
+
* @returns {string} Resource name string.
|
|
308
|
+
*/
|
|
309
|
+
readStreamPath(project: string, location: string, session: string, stream: string): string;
|
|
310
|
+
/**
|
|
311
|
+
* Parse the project from ReadStream resource.
|
|
312
|
+
*
|
|
313
|
+
* @param {string} readStreamName
|
|
314
|
+
* A fully-qualified path representing ReadStream resource.
|
|
315
|
+
* @returns {string} A string representing the project.
|
|
316
|
+
*/
|
|
317
|
+
matchProjectFromReadStreamName(readStreamName: string): string | number;
|
|
318
|
+
/**
|
|
319
|
+
* Parse the location from ReadStream resource.
|
|
320
|
+
*
|
|
321
|
+
* @param {string} readStreamName
|
|
322
|
+
* A fully-qualified path representing ReadStream resource.
|
|
323
|
+
* @returns {string} A string representing the location.
|
|
324
|
+
*/
|
|
325
|
+
matchLocationFromReadStreamName(readStreamName: string): string | number;
|
|
326
|
+
/**
|
|
327
|
+
* Parse the session from ReadStream resource.
|
|
328
|
+
*
|
|
329
|
+
* @param {string} readStreamName
|
|
330
|
+
* A fully-qualified path representing ReadStream resource.
|
|
331
|
+
* @returns {string} A string representing the session.
|
|
332
|
+
*/
|
|
333
|
+
matchSessionFromReadStreamName(readStreamName: string): string | number;
|
|
334
|
+
/**
|
|
335
|
+
* Parse the stream from ReadStream resource.
|
|
336
|
+
*
|
|
337
|
+
* @param {string} readStreamName
|
|
338
|
+
* A fully-qualified path representing ReadStream resource.
|
|
339
|
+
* @returns {string} A string representing the stream.
|
|
340
|
+
*/
|
|
341
|
+
matchStreamFromReadStreamName(readStreamName: string): string | number;
|
|
342
|
+
/**
|
|
343
|
+
* Return a fully-qualified table resource name string.
|
|
344
|
+
*
|
|
345
|
+
* @param {string} project
|
|
346
|
+
* @param {string} dataset
|
|
347
|
+
* @param {string} table
|
|
348
|
+
* @returns {string} Resource name string.
|
|
349
|
+
*/
|
|
350
|
+
tablePath(project: string, dataset: string, table: string): string;
|
|
351
|
+
/**
|
|
352
|
+
* Parse the project from Table resource.
|
|
353
|
+
*
|
|
354
|
+
* @param {string} tableName
|
|
355
|
+
* A fully-qualified path representing Table resource.
|
|
356
|
+
* @returns {string} A string representing the project.
|
|
357
|
+
*/
|
|
358
|
+
matchProjectFromTableName(tableName: string): string | number;
|
|
359
|
+
/**
|
|
360
|
+
* Parse the dataset from Table resource.
|
|
361
|
+
*
|
|
362
|
+
* @param {string} tableName
|
|
363
|
+
* A fully-qualified path representing Table resource.
|
|
364
|
+
* @returns {string} A string representing the dataset.
|
|
365
|
+
*/
|
|
366
|
+
matchDatasetFromTableName(tableName: string): string | number;
|
|
367
|
+
/**
|
|
368
|
+
* Parse the table from Table resource.
|
|
369
|
+
*
|
|
370
|
+
* @param {string} tableName
|
|
371
|
+
* A fully-qualified path representing Table resource.
|
|
372
|
+
* @returns {string} A string representing the table.
|
|
373
|
+
*/
|
|
374
|
+
matchTableFromTableName(tableName: string): string | number;
|
|
375
|
+
/**
|
|
376
|
+
* Return a fully-qualified writeStream resource name string.
|
|
377
|
+
*
|
|
378
|
+
* @param {string} project
|
|
379
|
+
* @param {string} dataset
|
|
380
|
+
* @param {string} table
|
|
381
|
+
* @param {string} stream
|
|
382
|
+
* @returns {string} Resource name string.
|
|
383
|
+
*/
|
|
384
|
+
writeStreamPath(project: string, dataset: string, table: string, stream: string): string;
|
|
385
|
+
/**
|
|
386
|
+
* Parse the project from WriteStream resource.
|
|
387
|
+
*
|
|
388
|
+
* @param {string} writeStreamName
|
|
389
|
+
* A fully-qualified path representing WriteStream resource.
|
|
390
|
+
* @returns {string} A string representing the project.
|
|
391
|
+
*/
|
|
392
|
+
matchProjectFromWriteStreamName(writeStreamName: string): string | number;
|
|
393
|
+
/**
|
|
394
|
+
* Parse the dataset from WriteStream resource.
|
|
395
|
+
*
|
|
396
|
+
* @param {string} writeStreamName
|
|
397
|
+
* A fully-qualified path representing WriteStream resource.
|
|
398
|
+
* @returns {string} A string representing the dataset.
|
|
399
|
+
*/
|
|
400
|
+
matchDatasetFromWriteStreamName(writeStreamName: string): string | number;
|
|
401
|
+
/**
|
|
402
|
+
* Parse the table from WriteStream resource.
|
|
403
|
+
*
|
|
404
|
+
* @param {string} writeStreamName
|
|
405
|
+
* A fully-qualified path representing WriteStream resource.
|
|
406
|
+
* @returns {string} A string representing the table.
|
|
407
|
+
*/
|
|
408
|
+
matchTableFromWriteStreamName(writeStreamName: string): string | number;
|
|
409
|
+
/**
|
|
410
|
+
* Parse the stream from WriteStream resource.
|
|
411
|
+
*
|
|
412
|
+
* @param {string} writeStreamName
|
|
413
|
+
* A fully-qualified path representing WriteStream resource.
|
|
414
|
+
* @returns {string} A string representing the stream.
|
|
415
|
+
*/
|
|
416
|
+
matchStreamFromWriteStreamName(writeStreamName: string): string | number;
|
|
417
|
+
/**
|
|
418
|
+
* Terminate the gRPC channel and close the client.
|
|
419
|
+
*
|
|
420
|
+
* The client will no longer be usable and all future behavior is undefined.
|
|
421
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
|
422
|
+
*/
|
|
423
|
+
close(): Promise<void>;
|
|
424
|
+
}
|