Skip to content

Commit 9631e97

Browse files
yoshi-automationyoshi-automation
committed
feat(dataform): update the API
#### dataform:v1beta1 The following keys were added: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.location - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.repeated - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.type - schemas.ActionErrorTable.description - schemas.ActionErrorTable.id - schemas.ActionErrorTable.properties.retentionDays.description - schemas.ActionErrorTable.properties.retentionDays.format - schemas.ActionErrorTable.properties.retentionDays.type - schemas.ActionErrorTable.properties.target.$ref - schemas.ActionErrorTable.properties.target.description - schemas.ActionErrorTable.type - schemas.ActionIncrementalLoadMode.description - schemas.ActionIncrementalLoadMode.id - schemas.ActionIncrementalLoadMode.properties.column.description - schemas.ActionIncrementalLoadMode.properties.column.type - schemas.ActionIncrementalLoadMode.type - schemas.ActionLoadConfig.description - schemas.ActionLoadConfig.id - schemas.ActionLoadConfig.properties.append.$ref - schemas.ActionLoadConfig.properties.append.description - schemas.ActionLoadConfig.properties.maximum.$ref - schemas.ActionLoadConfig.properties.maximum.description - schemas.ActionLoadConfig.properties.replace.$ref - schemas.ActionLoadConfig.properties.replace.description - schemas.ActionLoadConfig.properties.unique.$ref - schemas.ActionLoadConfig.properties.unique.description - schemas.ActionLoadConfig.type - schemas.ActionSimpleLoadMode.description - schemas.ActionSimpleLoadMode.id - schemas.ActionSimpleLoadMode.type - schemas.ActionSqlDefinition.description - schemas.ActionSqlDefinition.id - schemas.ActionSqlDefinition.properties.errorTable.$ref - schemas.ActionSqlDefinition.properties.errorTable.description - schemas.ActionSqlDefinition.properties.loadConfig.$ref - schemas.ActionSqlDefinition.properties.loadConfig.description - schemas.ActionSqlDefinition.properties.query.description - schemas.ActionSqlDefinition.properties.query.type - schemas.ActionSqlDefinition.type - schemas.CodeCompilationConfig.properties.builtinAssertionNamePrefix.description - schemas.CodeCompilationConfig.properties.builtinAssertionNamePrefix.type - schemas.CompilationResultAction.properties.dataPreparation.$ref - schemas.CompilationResultAction.properties.dataPreparation.description - schemas.DataPreparation.description - schemas.DataPreparation.id - schemas.DataPreparation.properties.contentsSql.$ref - schemas.DataPreparation.properties.contentsSql.description - schemas.DataPreparation.properties.contentsYaml.description - schemas.DataPreparation.properties.contentsYaml.type - schemas.DataPreparation.properties.dependencyTargets.description - schemas.DataPreparation.properties.dependencyTargets.items.$ref - schemas.DataPreparation.properties.dependencyTargets.type - schemas.DataPreparation.properties.disabled.description - schemas.DataPreparation.properties.disabled.type - schemas.DataPreparation.properties.tags.description - schemas.DataPreparation.properties.tags.items.type - schemas.DataPreparation.properties.tags.type - schemas.DataPreparation.type - schemas.DataPreparationAction.description - schemas.DataPreparationAction.id - schemas.DataPreparationAction.properties.contentsSql.$ref - schemas.DataPreparationAction.properties.contentsSql.description - schemas.DataPreparationAction.properties.contentsYaml.description - schemas.DataPreparationAction.properties.contentsYaml.readOnly - schemas.DataPreparationAction.properties.contentsYaml.type - schemas.DataPreparationAction.properties.generatedSql.description - schemas.DataPreparationAction.properties.generatedSql.readOnly - schemas.DataPreparationAction.properties.generatedSql.type - schemas.DataPreparationAction.properties.jobId.description - schemas.DataPreparationAction.properties.jobId.readOnly - schemas.DataPreparationAction.properties.jobId.type - schemas.DataPreparationAction.type - schemas.ErrorTable.description - schemas.ErrorTable.id - schemas.ErrorTable.properties.retentionDays.description - schemas.ErrorTable.properties.retentionDays.format - schemas.ErrorTable.properties.retentionDays.type - schemas.ErrorTable.properties.target.$ref - schemas.ErrorTable.properties.target.description - schemas.ErrorTable.type - schemas.IncrementalLoadMode.description - schemas.IncrementalLoadMode.id - schemas.IncrementalLoadMode.properties.column.description - schemas.IncrementalLoadMode.properties.column.type - schemas.IncrementalLoadMode.type - schemas.LoadConfig.description - schemas.LoadConfig.id - schemas.LoadConfig.properties.append.$ref - schemas.LoadConfig.properties.append.description - schemas.LoadConfig.properties.maximum.$ref - schemas.LoadConfig.properties.maximum.description - schemas.LoadConfig.properties.replace.$ref - schemas.LoadConfig.properties.replace.description - schemas.LoadConfig.properties.unique.$ref - schemas.LoadConfig.properties.unique.description - schemas.LoadConfig.type - schemas.SimpleLoadMode.description - schemas.SimpleLoadMode.id - schemas.SimpleLoadMode.type - schemas.SqlDefinition.description - schemas.SqlDefinition.id - schemas.SqlDefinition.properties.errorTable.$ref - schemas.SqlDefinition.properties.errorTable.description - schemas.SqlDefinition.properties.load.$ref - schemas.SqlDefinition.properties.load.description - schemas.SqlDefinition.properties.query.description - schemas.SqlDefinition.properties.query.type - schemas.SqlDefinition.type - schemas.WorkflowConfig.properties.disabled.description - schemas.WorkflowConfig.properties.disabled.type - schemas.WorkflowInvocationAction.properties.dataPreparationAction.$ref - schemas.WorkflowInvocationAction.properties.dataPreparationAction.description - schemas.WorkflowInvocationAction.properties.dataPreparationAction.readOnly The following keys were changed: - resources.projects.resources.locations.methods.updateConfig.description - resources.projects.resources.locations.resources.repositories.methods.list.description - resources.projects.resources.locations.resources.repositories.methods.patch.description - resources.projects.resources.locations.resources.repositories.resources.releaseConfigs.methods.patch.description - resources.projects.resources.locations.resources.repositories.resources.workflowConfigs.methods.patch.description
1 parent a1f35d0 commit 9631e97

File tree

2 files changed

+437
-11
lines changed

2 files changed

+437
-11
lines changed

‎discovery/dataform-v1beta1.json

Lines changed: 238 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,12 @@
172172
"name"
173173
],
174174
"parameters": {
175+
"extraLocationTypes": {
176+
"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.",
177+
"location": "query",
178+
"repeated": true,
179+
"type": "string"
180+
},
175181
"filter": {
176182
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
177183
"location": "query",
@@ -206,7 +212,7 @@
206212
]
207213
},
208214
"updateConfig": {
209-
"description": "Update default config for a given project and location. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields",
215+
"description": "Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*",
210216
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/config",
211217
"httpMethod": "PATCH",
212218
"id": "dataform.projects.locations.updateConfig",
@@ -486,7 +492,7 @@
486492
]
487493
},
488494
"list": {
489-
"description": "Lists Repositories in a given project and location.",
495+
"description": "Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.",
490496
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories",
491497
"httpMethod": "GET",
492498
"id": "dataform.projects.locations.repositories.list",
@@ -533,7 +539,7 @@
533539
]
534540
},
535541
"patch": {
536-
"description": "Updates a single Repository. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields",
542+
"description": "Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*",
537543
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}",
538544
"httpMethod": "PATCH",
539545
"id": "dataform.projects.locations.repositories.patch",
@@ -984,7 +990,7 @@
984990
]
985991
},
986992
"patch": {
987-
"description": "Updates a single ReleaseConfig. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields",
993+
"description": "Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*",
988994
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}",
989995
"httpMethod": "PATCH",
990996
"id": "dataform.projects.locations.repositories.releaseConfigs.patch",
@@ -1146,7 +1152,7 @@
11461152
]
11471153
},
11481154
"patch": {
1149-
"description": "Updates a single WorkflowConfig. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields",
1155+
"description": "Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*",
11501156
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}",
11511157
"httpMethod": "PATCH",
11521158
"id": "dataform.projects.locations.repositories.workflowConfigs.patch",
@@ -2141,9 +2147,84 @@
21412147
}
21422148
}
21432149
},
2144-
"revision": "20250306",
2150+
"revision": "20250420",
21452151
"rootUrl": "https://dataform.googleapis.com/",
21462152
"schemas": {
2153+
"ActionErrorTable": {
2154+
"description": "Error table information, used to write error data into a BigQuery table.",
2155+
"id": "ActionErrorTable",
2156+
"properties": {
2157+
"retentionDays": {
2158+
"description": "Error table partition expiration in days. Only positive values are allowed.",
2159+
"format": "int32",
2160+
"type": "integer"
2161+
},
2162+
"target": {
2163+
"$ref": "Target",
2164+
"description": "Error Table target."
2165+
}
2166+
},
2167+
"type": "object"
2168+
},
2169+
"ActionIncrementalLoadMode": {
2170+
"description": "Load definition for incremental load modes",
2171+
"id": "ActionIncrementalLoadMode",
2172+
"properties": {
2173+
"column": {
2174+
"description": "Column name for incremental load modes",
2175+
"type": "string"
2176+
}
2177+
},
2178+
"type": "object"
2179+
},
2180+
"ActionLoadConfig": {
2181+
"description": "Simplified load configuration for actions",
2182+
"id": "ActionLoadConfig",
2183+
"properties": {
2184+
"append": {
2185+
"$ref": "ActionSimpleLoadMode",
2186+
"description": "Append into destination table"
2187+
},
2188+
"maximum": {
2189+
"$ref": "ActionIncrementalLoadMode",
2190+
"description": "Insert records where the value exceeds the previous maximum value for a column in the destination table"
2191+
},
2192+
"replace": {
2193+
"$ref": "ActionSimpleLoadMode",
2194+
"description": "Replace destination table"
2195+
},
2196+
"unique": {
2197+
"$ref": "ActionIncrementalLoadMode",
2198+
"description": "Insert records where the value of a column is not already present in the destination table"
2199+
}
2200+
},
2201+
"type": "object"
2202+
},
2203+
"ActionSimpleLoadMode": {
2204+
"description": "Simple load definition",
2205+
"id": "ActionSimpleLoadMode",
2206+
"properties": {},
2207+
"type": "object"
2208+
},
2209+
"ActionSqlDefinition": {
2210+
"description": "Definition of a SQL Data Preparation",
2211+
"id": "ActionSqlDefinition",
2212+
"properties": {
2213+
"errorTable": {
2214+
"$ref": "ActionErrorTable",
2215+
"description": "Error table configuration,"
2216+
},
2217+
"loadConfig": {
2218+
"$ref": "ActionLoadConfig",
2219+
"description": "Load configuration."
2220+
},
2221+
"query": {
2222+
"description": "The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.",
2223+
"type": "string"
2224+
}
2225+
},
2226+
"type": "object"
2227+
},
21472228
"Assertion": {
21482229
"description": "Represents an assertion upon a SQL query which is required return zero rows.",
21492230
"id": "Assertion",
@@ -2240,6 +2321,10 @@
22402321
"description": "Optional. The default schema (BigQuery dataset ID) for assertions.",
22412322
"type": "string"
22422323
},
2324+
"builtinAssertionNamePrefix": {
2325+
"description": "Optional. The prefix to prepend to built-in assertion names.",
2326+
"type": "string"
2327+
},
22432328
"databaseSuffix": {
22442329
"description": "Optional. The suffix that should be appended to all database (Google Cloud project ID) names.",
22452330
"type": "string"
@@ -2519,6 +2604,10 @@
25192604
"$ref": "Target",
25202605
"description": "The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result."
25212606
},
2607+
"dataPreparation": {
2608+
"$ref": "DataPreparation",
2609+
"description": "The data preparation executed by this action."
2610+
},
25222611
"declaration": {
25232612
"$ref": "Declaration",
25242613
"description": "The declaration declared by this action."
@@ -2600,6 +2689,65 @@
26002689
},
26012690
"type": "object"
26022691
},
2692+
"DataPreparation": {
2693+
"description": "Defines a compiled Data Preparation entity",
2694+
"id": "DataPreparation",
2695+
"properties": {
2696+
"contentsSql": {
2697+
"$ref": "SqlDefinition",
2698+
"description": "SQL definition for a Data Preparation. Contains a SQL query and additional context information."
2699+
},
2700+
"contentsYaml": {
2701+
"description": "The data preparation definition, stored as a YAML string.",
2702+
"type": "string"
2703+
},
2704+
"dependencyTargets": {
2705+
"description": "A list of actions that this action depends on.",
2706+
"items": {
2707+
"$ref": "Target"
2708+
},
2709+
"type": "array"
2710+
},
2711+
"disabled": {
2712+
"description": "Whether this action is disabled (i.e. should not be run).",
2713+
"type": "boolean"
2714+
},
2715+
"tags": {
2716+
"description": "Arbitrary, user-defined tags on this action.",
2717+
"items": {
2718+
"type": "string"
2719+
},
2720+
"type": "array"
2721+
}
2722+
},
2723+
"type": "object"
2724+
},
2725+
"DataPreparationAction": {
2726+
"description": "Represents a workflow action that will run a Data Preparation.",
2727+
"id": "DataPreparationAction",
2728+
"properties": {
2729+
"contentsSql": {
2730+
"$ref": "ActionSqlDefinition",
2731+
"description": "SQL definition for a Data Preparation. Contains a SQL query and additional context information."
2732+
},
2733+
"contentsYaml": {
2734+
"description": "Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow.",
2735+
"readOnly": true,
2736+
"type": "string"
2737+
},
2738+
"generatedSql": {
2739+
"description": "Output only. The generated BigQuery SQL script that will be executed. For reference only.",
2740+
"readOnly": true,
2741+
"type": "string"
2742+
},
2743+
"jobId": {
2744+
"description": "Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.",
2745+
"readOnly": true,
2746+
"type": "string"
2747+
}
2748+
},
2749+
"type": "object"
2750+
},
26032751
"Declaration": {
26042752
"description": "Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.",
26052753
"id": "Declaration",
@@ -2649,6 +2797,22 @@
26492797
"properties": {},
26502798
"type": "object"
26512799
},
2800+
"ErrorTable": {
2801+
"description": "Error table information, used to write error data into a BigQuery table.",
2802+
"id": "ErrorTable",
2803+
"properties": {
2804+
"retentionDays": {
2805+
"description": "Error table partition expiration in days. Only positive values are allowed.",
2806+
"format": "int32",
2807+
"type": "integer"
2808+
},
2809+
"target": {
2810+
"$ref": "Target",
2811+
"description": "Error Table target."
2812+
}
2813+
},
2814+
"type": "object"
2815+
},
26522816
"Expr": {
26532817
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
26542818
"id": "Expr",
@@ -2813,6 +2977,17 @@
28132977
},
28142978
"type": "object"
28152979
},
2980+
"IncrementalLoadMode": {
2981+
"description": "Load definition for incremental load modes",
2982+
"id": "IncrementalLoadMode",
2983+
"properties": {
2984+
"column": {
2985+
"description": "Column name for incremental load modes",
2986+
"type": "string"
2987+
}
2988+
},
2989+
"type": "object"
2990+
},
28162991
"IncrementalTableConfig": {
28172992
"description": "Contains settings for relations of type `INCREMENTAL_TABLE`.",
28182993
"id": "IncrementalTableConfig",
@@ -3087,6 +3262,29 @@
30873262
},
30883263
"type": "object"
30893264
},
3265+
"LoadConfig": {
3266+
"description": "Simplified load configuration for actions",
3267+
"id": "LoadConfig",
3268+
"properties": {
3269+
"append": {
3270+
"$ref": "SimpleLoadMode",
3271+
"description": "Append into destination table"
3272+
},
3273+
"maximum": {
3274+
"$ref": "IncrementalLoadMode",
3275+
"description": "Insert records where the value exceeds the previous maximum value for a column in the destination table"
3276+
},
3277+
"replace": {
3278+
"$ref": "SimpleLoadMode",
3279+
"description": "Replace destination table"
3280+
},
3281+
"unique": {
3282+
"$ref": "IncrementalLoadMode",
3283+
"description": "Insert records where the value of a column is not already present in the destination table"
3284+
}
3285+
},
3286+
"type": "object"
3287+
},
30903288
"Location": {
30913289
"description": "A resource that represents a Google Cloud location.",
30923290
"id": "Location",
@@ -3854,6 +4052,31 @@
38544052
},
38554053
"type": "object"
38564054
},
4055+
"SimpleLoadMode": {
4056+
"description": "Simple load definition",
4057+
"id": "SimpleLoadMode",
4058+
"properties": {},
4059+
"type": "object"
4060+
},
4061+
"SqlDefinition": {
4062+
"description": "Definition of a SQL Data Preparation",
4063+
"id": "SqlDefinition",
4064+
"properties": {
4065+
"errorTable": {
4066+
"$ref": "ErrorTable",
4067+
"description": "Error table configuration,"
4068+
},
4069+
"load": {
4070+
"$ref": "LoadConfig",
4071+
"description": "Load configuration."
4072+
},
4073+
"query": {
4074+
"description": "The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.",
4075+
"type": "string"
4076+
}
4077+
},
4078+
"type": "object"
4079+
},
38574080
"SshAuthenticationConfig": {
38584081
"description": "Configures fields for performing SSH authentication.",
38594082
"id": "SshAuthenticationConfig",
@@ -3987,6 +4210,10 @@
39874210
"description": "Optional. Optional schedule (in cron format) for automatic execution of this workflow config.",
39884211
"type": "string"
39894212
},
4213+
"disabled": {
4214+
"description": "Optional. Disables automatic creation of workflow invocations.",
4215+
"type": "boolean"
4216+
},
39904217
"internalMetadata": {
39914218
"description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.",
39924219
"readOnly": true,
@@ -4104,6 +4331,11 @@
41044331
"description": "Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.",
41054332
"readOnly": true
41064333
},
4334+
"dataPreparationAction": {
4335+
"$ref": "DataPreparationAction",
4336+
"description": "Output only. The workflow action's data preparation action details.",
4337+
"readOnly": true
4338+
},
41074339
"failureReason": {
41084340
"description": "Output only. If and only if action's state is FAILED a failure reason is set.",
41094341
"readOnly": true,

0 commit comments

Comments
 (0)