|
2194 | 2194 | } |
2195 | 2195 | } |
2196 | 2196 | }, |
2197 | | - "revision": "20240918", |
| 2197 | + "revision": "20241008", |
2198 | 2198 | "rootUrl": "https://bigtableadmin.googleapis.com/", |
2199 | 2199 | "schemas": { |
2200 | 2200 | "AppProfile": { |
|
2325 | 2325 | "id": "AutomatedBackupPolicy", |
2326 | 2326 | "properties": { |
2327 | 2327 | "frequency": { |
2328 | | - "description": "Required. How frequently automated backups should occur. The only supported value at this time is 24 hours.", |
| 2328 | + "description": "How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.", |
2329 | 2329 | "format": "google-duration", |
2330 | 2330 | "type": "string" |
2331 | 2331 | }, |
|
3174 | 3174 | "type": "object" |
3175 | 3175 | }, |
3176 | 3176 | "GoogleBigtableAdminV2TypeAggregate": { |
3177 | | - "description": "A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` .", |
| 3177 | + "description": "A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` .", |
3178 | 3178 | "id": "GoogleBigtableAdminV2TypeAggregate", |
3179 | 3179 | "properties": { |
3180 | 3180 | "hllppUniqueCount": { |
|
3183 | 3183 | }, |
3184 | 3184 | "inputType": { |
3185 | 3185 | "$ref": "Type", |
3186 | | - "description": "Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs." |
| 3186 | + "description": "Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs." |
3187 | 3187 | }, |
3188 | 3188 | "max": { |
3189 | 3189 | "$ref": "GoogleBigtableAdminV2TypeAggregateMax", |
|
3195 | 3195 | }, |
3196 | 3196 | "stateType": { |
3197 | 3197 | "$ref": "Type", |
3198 | | - "description": "Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding.", |
| 3198 | + "description": "Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen.", |
3199 | 3199 | "readOnly": true |
3200 | 3200 | }, |
3201 | 3201 | "sum": { |
|
3252 | 3252 | "properties": { |
3253 | 3253 | "encoding": { |
3254 | 3254 | "$ref": "GoogleBigtableAdminV2TypeBytesEncoding", |
3255 | | - "description": "The encoding to use when converting to/from lower level types." |
| 3255 | + "description": "The encoding to use when converting to or from lower level types." |
3256 | 3256 | } |
3257 | 3257 | }, |
3258 | 3258 | "type": "object" |
3259 | 3259 | }, |
3260 | 3260 | "GoogleBigtableAdminV2TypeBytesEncoding": { |
3261 | | - "description": "Rules used to convert to/from lower level types.", |
| 3261 | + "description": "Rules used to convert to or from lower level types.", |
3262 | 3262 | "id": "GoogleBigtableAdminV2TypeBytesEncoding", |
3263 | 3263 | "properties": { |
3264 | 3264 | "raw": { |
|
3269 | 3269 | "type": "object" |
3270 | 3270 | }, |
3271 | 3271 | "GoogleBigtableAdminV2TypeBytesEncodingRaw": { |
3272 | | - "description": "Leaves the value \"as-is\" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A", |
| 3272 | + "description": "Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported.", |
3273 | 3273 | "id": "GoogleBigtableAdminV2TypeBytesEncodingRaw", |
3274 | 3274 | "properties": {}, |
3275 | 3275 | "type": "object" |
|
3298 | 3298 | "properties": { |
3299 | 3299 | "encoding": { |
3300 | 3300 | "$ref": "GoogleBigtableAdminV2TypeInt64Encoding", |
3301 | | - "description": "The encoding to use when converting to/from lower level types." |
| 3301 | + "description": "The encoding to use when converting to or from lower level types." |
3302 | 3302 | } |
3303 | 3303 | }, |
3304 | 3304 | "type": "object" |
3305 | 3305 | }, |
3306 | 3306 | "GoogleBigtableAdminV2TypeInt64Encoding": { |
3307 | | - "description": "Rules used to convert to/from lower level types.", |
| 3307 | + "description": "Rules used to convert to or from lower level types.", |
3308 | 3308 | "id": "GoogleBigtableAdminV2TypeInt64Encoding", |
3309 | 3309 | "properties": { |
3310 | 3310 | "bigEndianBytes": { |
|
3315 | 3315 | "type": "object" |
3316 | 3316 | }, |
3317 | 3317 | "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes": { |
3318 | | - "description": "Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", |
| 3318 | + "description": "Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", |
3319 | 3319 | "id": "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes", |
3320 | 3320 | "properties": { |
3321 | 3321 | "bytesType": { |
|
3347 | 3347 | "properties": { |
3348 | 3348 | "encoding": { |
3349 | 3349 | "$ref": "GoogleBigtableAdminV2TypeStringEncoding", |
3350 | | - "description": "The encoding to use when converting to/from lower level types." |
| 3350 | + "description": "The encoding to use when converting to or from lower level types." |
3351 | 3351 | } |
3352 | 3352 | }, |
3353 | 3353 | "type": "object" |
3354 | 3354 | }, |
3355 | 3355 | "GoogleBigtableAdminV2TypeStringEncoding": { |
3356 | | - "description": "Rules used to convert to/from lower level types.", |
| 3356 | + "description": "Rules used to convert to or from lower level types.", |
3357 | 3357 | "id": "GoogleBigtableAdminV2TypeStringEncoding", |
3358 | 3358 | "properties": { |
3359 | 3359 | "utf8Bytes": { |
|
3369 | 3369 | "type": "object" |
3370 | 3370 | }, |
3371 | 3371 | "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes": { |
3372 | | - "description": "UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)`", |
| 3372 | + "description": "UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)`", |
3373 | 3373 | "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", |
3374 | 3374 | "properties": {}, |
3375 | 3375 | "type": "object" |
|
4302 | 4302 | "type": "object" |
4303 | 4303 | }, |
4304 | 4304 | "Type": { |
4305 | | - "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) \u003e INT64(-1)`, but `STRING(\"-00001\") \u003e STRING(\"00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", |
| 4305 | + "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) \u003c= Encode(Y)` if and only if `X \u003c= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both \"{'foo': '1', 'bar': '2'}\" and \"{'bar': '2', 'foo': '1'}\" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) \u003e INT64(-1)`, but `STRING(\"-00001\") \u003e STRING(\"00001\")`.", |
4306 | 4306 | "id": "Type", |
4307 | 4307 | "properties": { |
4308 | 4308 | "aggregateType": { |
|
0 commit comments