From 6096d3b32f925774606133590d0e9ea5c6eba2db Mon Sep 17 00:00:00 2001
From: Yoshi Automation Instance Methods
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the IAM policy.
- subscribe(name, body=None, x__xgafv=None)
subscribe(name, body, x__xgafv=None)
Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.
testIamPermissions(resource, body=None, x__xgafv=None)
subscribe(name, body=None, x__xgafv=None)
+ subscribe(name, body, x__xgafv=None)
Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project. Args: @@ -836,6 +836,15 @@Method Details
"a_key": "A String", }, "messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. + "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + { # All supported message transforms types. + "enabled": True or False, # Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + "code": "A String", # Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ``` + "functionName": "A String", # Required. Name of the JavasScript function that should applied to Pub/Sub messages. + }, + }, + ], "name": "A String", # Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. "pushConfig": { # Configuration for a push delivery endpoint. # Optional. If push delivery is used with this subscription, this field is used to configure it. "attributes": { # Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index ab00e85fe17..8c311ab890c 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1022,7 +1022,7 @@ } } }, -"revision": "20250126", +"revision": "20250203", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AnalyticsHubSubscriptionInfo": { @@ -1160,7 +1160,7 @@ "id": "BigQueryDatasetSource", "properties": { "dataset": { -"description": "Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", +"description": "Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", "type": "string" }, "restrictedExportPolicy": { @@ -1620,6 +1620,13 @@ "format": "google-duration", "type": "string" }, +"messageTransforms": { +"description": "Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.", +"items": { +"$ref": "MessageTransform" +}, +"type": "array" +}, "name": { "description": "Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.", "type": "string" @@ -1660,6 +1667,21 @@ }, "type": "object" }, +"JavaScriptUDF": { +"description": "User-defined JavaScript function that can transform or filter a Pub/Sub message.", +"id": "JavaScriptUDF", +"properties": { +"code": { +"description": "Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ```", +"type": "string" +}, +"functionName": { +"description": "Required. Name of the JavasScript function that should applied to Pub/Sub messages.", +"type": "string" +} +}, +"type": "object" +}, "LinkedResource": { "description": "Reference to a linked resource tracked by this Subscription.", "id": "LinkedResource", @@ -1927,6 +1949,21 @@ }, "type": "object" }, +"MessageTransform": { +"description": "All supported message transforms types.", +"id": "MessageTransform", +"properties": { +"enabled": { +"description": "Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`.", +"type": "boolean" +}, +"javascriptUdf": { +"$ref": "JavaScriptUDF", +"description": "Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`." +} +}, +"type": "object" +}, "NoWrapper": { "description": "Sets the `data` field as the HTTP body for delivery.", "id": "NoWrapper", From cf5a6691fe84de6e0624633edf99beafdb98c0b2 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 11 Feb 2025 07:09:07 +0000 Subject: [PATCH 02/31] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - resources.rowAccessPolicies.methods.batchDelete (Total Keys: 19) - resources.rowAccessPolicies.methods.delete (Total Keys: 24) - resources.rowAccessPolicies.methods.get (Total Keys: 23) - resources.rowAccessPolicies.methods.insert (Total Keys: 20) - resources.rowAccessPolicies.methods.update (Total Keys: 24) - schemas.BatchDeleteRowAccessPoliciesRequest (Total Keys: 5) - schemas.JobConfigurationQuery.properties.writeIncrementalResults.type (Total Keys: 1) - schemas.QueryRequest.properties.writeIncrementalResults.type (Total Keys: 1) - schemas.RowAccessPolicy.properties.grantees (Total Keys: 2) - schemas.StoredColumnsUnusedReason (Total Keys: 6) - schemas.StoredColumnsUsage (Total Keys: 6) - schemas.TrainingOptions.properties.forecastLimitLowerBound (Total Keys: 2) - schemas.TrainingOptions.properties.forecastLimitUpperBound (Total Keys: 2) - schemas.VectorSearchStatistics.properties.storedColumnsUsages (Total Keys: 2) --- docs/dyn/bigquery_v2.jobs.html | 111 ++++++ docs/dyn/bigquery_v2.models.html | 16 + docs/dyn/bigquery_v2.rowAccessPolicies.html | 199 ++++++++++ .../documents/bigquery.v2.json | 361 +++++++++++++++++- 4 files changed, 686 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 1f311640876..bb75284a32f 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -546,6 +546,7 @@ Method Details
}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "etag": "A String", # Output only. A hash of this resource. @@ -1049,6 +1050,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -1445,6 +1448,25 @@Method Details
}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -1966,6 +1988,7 @@Method Details
}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "etag": "A String", # Output only. A hash of this resource. @@ -2469,6 +2492,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -2865,6 +2890,25 @@Method Details
}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -3467,6 +3511,7 @@Method Details
}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "etag": "A String", # Output only. A hash of this resource. @@ -3970,6 +4015,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -4366,6 +4413,25 @@Method Details
}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -4858,6 +4924,7 @@Method Details
}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "etag": "A String", # Output only. A hash of this resource. @@ -5361,6 +5428,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -5757,6 +5826,25 @@Method Details
}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -6272,6 +6360,7 @@Method Details
}, ], "writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, }, "errorResult": { # Error details. # A result object that will be present only if the job has failed. @@ -6777,6 +6866,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -7173,6 +7264,25 @@Method Details
}, ], "indexUsageMode": "A String", # Specifies the index usage mode for the query. + "storedColumnsUsages": [ # Specifies the usage of stored columns in the query when stored columns are used in the query. + { # Indicates the stored columns usage in the query. + "baseTable": { # Specifies the base table. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "isQueryAccelerated": True or False, # Specifies whether the query was accelerated with stored columns. + "storedColumnsUnusedReasons": [ # If stored columns were not used, explain why. + { # If the stored column was not used, explain why. + "code": "A String", # Specifies the high-level reason for the unused scenario, each reason must have a code associated. + "message": "A String", # Specifies the detailed description for the scenario. + "uncoveredColumns": [ # Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + "A String", + ], + }, + ], + }, + ], }, }, "quotaDeferments": [ # Output only. Quotas which delayed this job's start time. @@ -7324,6 +7434,7 @@Method Details
"timeoutMs": 42, # Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true. "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's GoogleSQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. "useQueryCache": true, # Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. + "writeIncrementalResults": True or False, # Optional. This is only supported for SELECT query. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/bigquery_v2.models.html b/docs/dyn/bigquery_v2.models.html index ccdd0aab880..c265f530b21 100644 --- a/docs/dyn/bigquery_v2.models.html +++ b/docs/dyn/bigquery_v2.models.html @@ -687,6 +687,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -1081,6 +1083,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -1763,6 +1767,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -2157,6 +2163,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -2848,6 +2856,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -3242,6 +3252,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -3912,6 +3924,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], @@ -4306,6 +4320,8 @@Method Details
"enableGlobalExplain": True or False, # If true, enable global explanation during training. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. + "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + "forecastLimitUpperBound": 3.14, # The forecast limit upper bound that was used during ARIMA model training with limits. "hiddenUnits": [ # Hidden units for dnn models. "A String", ], diff --git a/docs/dyn/bigquery_v2.rowAccessPolicies.html b/docs/dyn/bigquery_v2.rowAccessPolicies.html index c2bbb393a1f..fe7b0b10edc 100644 --- a/docs/dyn/bigquery_v2.rowAccessPolicies.html +++ b/docs/dyn/bigquery_v2.rowAccessPolicies.html @@ -74,12 +74,24 @@BigQuery API . rowAccessPolicies
Instance Methods
++
+batchDelete(projectId, datasetId, tableId, body=None, x__xgafv=None)Deletes provided row access policies.
Close httplib2 connections.
++
+delete(projectId, datasetId, tableId, policyId, force=None, x__xgafv=None)Deletes a row access policy.
++
+get(projectId, datasetId, tableId, policyId, x__xgafv=None)Gets the specified row access policy by policy ID.
getIamPolicy(resource, body=None, x__xgafv=None)Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
++
+insert(projectId, datasetId, tableId, body=None, x__xgafv=None)Creates a row access policy.
list(projectId, datasetId, tableId, pageSize=None, pageToken=None, x__xgafv=None)Lists all row access policies on the specified table.
@@ -89,12 +101,91 @@Instance Methods
testIamPermissions(resource, body=None, x__xgafv=None)Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
++
+update(projectId, datasetId, tableId, policyId, body=None, x__xgafv=None)Updates a row access policy.
Method Details
+++batchDelete(projectId, datasetId, tableId, body=None, x__xgafv=None)+Deletes provided row access policies. + +Args: + projectId: string, Required. Project ID of the table to delete the row access policies. (required) + datasetId: string, Required. Dataset ID of the table to delete the row access policies. (required) + tableId: string, Required. Table ID of the table to delete the row access policies. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for the BatchDeleteRowAccessPoliciesRequest method. + "force": True or False, # If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it. + "policyIds": [ # Required. Policy IDs of the row access policies. + "A String", + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format +++close()Close httplib2 connections.++ +delete(projectId, datasetId, tableId, policyId, force=None, x__xgafv=None)+Deletes a row access policy. + +Args: + projectId: string, Required. Project ID of the table to delete the row access policy. (required) + datasetId: string, Required. Dataset ID of the table to delete the row access policy. (required) + tableId: string, Required. Table ID of the table to delete the row access policy. (required) + policyId: string, Required. Policy ID of the row access policy. (required) + force: boolean, If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++++get(projectId, datasetId, tableId, policyId, x__xgafv=None)+Gets the specified row access policy by policy ID. + +Args: + projectId: string, Required. Project ID of the table to get the row access policy. (required) + datasetId: string, Required. Dataset ID of the table to get the row access policy. (required) + tableId: string, Required. Table ID of the table to get the row access policy. (required) + policyId: string, Required. Policy ID of the row access policy. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy. + "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch. + "etag": "A String", # Output only. A hash of this resource. + "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 + "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users. + "A String", + ], + "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch. + "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy. + "datasetId": "A String", # Required. The ID of the dataset containing this row access policy. + "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + "projectId": "A String", # Required. The ID of the project containing this row access policy. + "tableId": "A String", # Required. The ID of the table containing this row access policy. + }, +}++getIamPolicy(resource, body=None, x__xgafv=None)Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @@ -151,6 +242,58 @@Method Details
}++insert(projectId, datasetId, tableId, body=None, x__xgafv=None)+Creates a row access policy. + +Args: + projectId: string, Required. Project ID of the table to get the row access policy. (required) + datasetId: string, Required. Dataset ID of the table to get the row access policy. (required) + tableId: string, Required. Table ID of the table to get the row access policy. (required) + body: object, The request body. + The object takes the form of: + +{ # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy. + "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch. + "etag": "A String", # Output only. A hash of this resource. + "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 + "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users. + "A String", + ], + "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch. + "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy. + "datasetId": "A String", # Required. The ID of the dataset containing this row access policy. + "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + "projectId": "A String", # Required. The ID of the project containing this row access policy. + "tableId": "A String", # Required. The ID of the table containing this row access policy. + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy. + "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch. + "etag": "A String", # Output only. A hash of this resource. + "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 + "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users. + "A String", + ], + "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch. + "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy. + "datasetId": "A String", # Required. The ID of the dataset containing this row access policy. + "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + "projectId": "A String", # Required. The ID of the project containing this row access policy. + "tableId": "A String", # Required. The ID of the table containing this row access policy. + }, +}++list(projectId, datasetId, tableId, pageSize=None, pageToken=None, x__xgafv=None)Lists all row access policies on the specified table. @@ -176,6 +319,9 @@Method Details
"creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch. "etag": "A String", # Output only. A hash of this resource. "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 + "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users. + "A String", + ], "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch. "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy. "datasetId": "A String", # Required. The ID of the dataset containing this row access policy. @@ -232,4 +378,57 @@Method Details
}++update(projectId, datasetId, tableId, policyId, body=None, x__xgafv=None)+Updates a row access policy. + +Args: + projectId: string, Required. Project ID of the table to get the row access policy. (required) + datasetId: string, Required. Dataset ID of the table to get the row access policy. (required) + tableId: string, Required. Table ID of the table to get the row access policy. (required) + policyId: string, Required. Policy ID of the row access policy. (required) + body: object, The request body. + The object takes the form of: + +{ # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy. + "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch. + "etag": "A String", # Output only. A hash of this resource. + "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 + "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users. + "A String", + ], + "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch. + "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy. + "datasetId": "A String", # Required. The ID of the dataset containing this row access policy. + "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + "projectId": "A String", # Required. The ID of the project containing this row access policy. + "tableId": "A String", # Required. The ID of the table containing this row access policy. + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy. + "creationTime": "A String", # Output only. The time when this row access policy was created, in milliseconds since the epoch. + "etag": "A String", # Output only. A hash of this resource. + "filterPredicate": "A String", # Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 + "grantees": [ # Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users. + "A String", + ], + "lastModifiedTime": "A String", # Output only. The time when this row access policy was last modified, in milliseconds since the epoch. + "rowAccessPolicyReference": { # Id path of a row access policy. # Required. Reference describing the ID of this row access policy. + "datasetId": "A String", # Required. The ID of the dataset containing this row access policy. + "policyId": "A String", # Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + "projectId": "A String", # Required. The ID of the project containing this row access policy. + "tableId": "A String", # Required. The ID of the table containing this row access policy. + }, +}+